mizuho 0.9.6 → 0.9.8
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +4 -2
- data/Rakefile +0 -37
- data/asciidoc/BUGS +9 -18
- data/asciidoc/BUGS.txt +5 -14
- data/asciidoc/CHANGELOG +1433 -266
- data/asciidoc/CHANGELOG.txt +2821 -1810
- data/asciidoc/COPYING +339 -339
- data/asciidoc/COPYRIGHT +18 -18
- data/asciidoc/INSTALL +189 -30
- data/asciidoc/INSTALL.txt +175 -19
- data/asciidoc/MANIFEST +88 -0
- data/asciidoc/Makefile.in +29 -13
- data/asciidoc/README +16 -17
- data/asciidoc/README.txt +35 -36
- data/asciidoc/a2x.py +902 -0
- data/asciidoc/asciidoc.conf +610 -455
- data/asciidoc/asciidoc.py +1965 -1061
- data/asciidoc/asciidocapi.py +257 -0
- data/asciidoc/common.aap +2 -2
- data/asciidoc/configure +1170 -1023
- data/asciidoc/configure.ac +1 -1
- data/asciidoc/dblatex/asciidoc-dblatex.xsl +42 -0
- data/asciidoc/doc/a2x.1 +559 -102
- data/asciidoc/doc/a2x.1.txt +233 -91
- data/asciidoc/doc/article-docinfo.xml +87 -0
- data/asciidoc/doc/article.pdf +0 -0
- data/asciidoc/doc/article.txt +139 -122
- data/asciidoc/doc/asciidoc.1 +157 -46
- data/asciidoc/doc/asciidoc.1.txt +171 -118
- data/asciidoc/doc/asciidoc.conf +7 -8
- data/asciidoc/doc/asciidoc.dict +960 -635
- data/asciidoc/doc/asciidoc.txt +2335 -1464
- data/asciidoc/doc/asciidocapi.txt +189 -0
- data/asciidoc/doc/asciimathml.txt +14 -17
- data/asciidoc/doc/book-multi.txt +181 -155
- data/asciidoc/doc/book.epub +0 -0
- data/asciidoc/doc/book.txt +156 -131
- data/asciidoc/doc/customers.csv +18 -18
- data/asciidoc/doc/epub-notes.txt +210 -0
- data/asciidoc/doc/faq.txt +1122 -547
- data/asciidoc/doc/latex-backend.txt +192 -191
- data/asciidoc/doc/latex-bugs.txt +134 -0
- data/asciidoc/doc/latex-filter.pdf +0 -0
- data/asciidoc/doc/latex-filter.txt +196 -0
- data/asciidoc/doc/latexmath.txt +13 -136
- data/asciidoc/doc/latexmathml.txt +2 -2
- data/asciidoc/doc/main.aap +233 -297
- data/asciidoc/doc/music-filter.pdf +0 -0
- data/asciidoc/doc/music-filter.txt +55 -65
- data/asciidoc/doc/publishing-ebooks-with-asciidoc.txt +398 -0
- data/asciidoc/doc/slidy-example.txt +167 -0
- data/asciidoc/doc/slidy.txt +113 -0
- data/asciidoc/doc/source-highlight-filter.pdf +0 -0
- data/asciidoc/doc/source-highlight-filter.txt +45 -20
- data/asciidoc/doc/testasciidoc.txt +231 -0
- data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +30 -8
- data/asciidoc/docbook-xsl/chunked.xsl +17 -19
- data/asciidoc/docbook-xsl/common.xsl +106 -67
- data/asciidoc/docbook-xsl/epub.xsl +35 -0
- data/asciidoc/docbook-xsl/fo.xsl +3 -0
- data/asciidoc/docbook-xsl/htmlhelp.xsl +16 -17
- data/asciidoc/docbook-xsl/manpage.xsl +31 -31
- data/asciidoc/docbook-xsl/text.xsl +6 -1
- data/asciidoc/docbook-xsl/xhtml.xsl +14 -14
- data/asciidoc/docbook45.conf +759 -0
- data/asciidoc/filters/code/code-filter-readme.txt +37 -37
- data/asciidoc/filters/code/code-filter-test.txt +15 -15
- data/asciidoc/filters/code/code-filter.conf +8 -8
- data/asciidoc/filters/graphviz/asciidoc-graphviz-sample.txt +104 -64
- data/asciidoc/filters/graphviz/graphviz-filter.conf +20 -16
- data/asciidoc/filters/graphviz/graphviz2png.py +54 -39
- data/asciidoc/filters/latex/latex-filter.conf +18 -0
- data/asciidoc/filters/latex/latex2png.py +216 -0
- data/asciidoc/filters/music/music-filter.conf +8 -17
- data/asciidoc/filters/music/music2png.py +40 -32
- data/asciidoc/filters/source/source-highlight-filter.conf +40 -34
- data/asciidoc/help.conf +261 -96
- data/asciidoc/html4.conf +505 -460
- data/asciidoc/html5.conf +686 -0
- data/asciidoc/images/highlighter.png +0 -0
- data/asciidoc/images/icons/caution.png +0 -0
- data/asciidoc/images/icons/example.png +0 -0
- data/asciidoc/images/icons/important.png +0 -0
- data/asciidoc/images/icons/note.png +0 -0
- data/asciidoc/images/icons/tip.png +0 -0
- data/asciidoc/images/icons/warning.png +0 -0
- data/asciidoc/images/smallnew.png +0 -0
- data/asciidoc/javascripts/asciidoc.js +189 -0
- data/asciidoc/javascripts/slidy.js +2845 -0
- data/asciidoc/javascripts/toc.js +8 -0
- data/asciidoc/lang-de.conf +57 -0
- data/asciidoc/lang-en.conf +54 -0
- data/asciidoc/lang-es.conf +49 -9
- data/asciidoc/lang-fr.conf +59 -0
- data/asciidoc/lang-hu.conf +55 -0
- data/asciidoc/lang-it.conf +55 -0
- data/asciidoc/lang-nl.conf +57 -0
- data/asciidoc/lang-pt-BR.conf +56 -0
- data/asciidoc/lang-ru.conf +60 -0
- data/asciidoc/lang-uk.conf +60 -0
- data/asciidoc/latex.conf +700 -663
- data/asciidoc/main.aap +77 -0
- data/asciidoc/slidy.conf +136 -0
- data/asciidoc/{examples/website/xhtml11-manpage.css → stylesheets/asciidoc-manpage.css} +1 -1
- data/asciidoc/stylesheets/asciidoc.css +508 -0
- data/asciidoc/stylesheets/docbook-xsl.css +322 -272
- data/asciidoc/stylesheets/flask-manpage.css +1 -0
- data/asciidoc/stylesheets/flask.css +584 -0
- data/asciidoc/stylesheets/pygments.css +66 -0
- data/asciidoc/stylesheets/slidy.css +445 -0
- data/asciidoc/stylesheets/toc2.css +33 -0
- data/asciidoc/stylesheets/volnitsky-manpage.css +1 -0
- data/asciidoc/stylesheets/volnitsky.css +435 -0
- data/asciidoc/stylesheets/xhtml11-quirks.css +5 -3
- data/asciidoc/tests/asciidocapi.py +257 -0
- data/asciidoc/tests/data/deprecated-quotes.txt +12 -0
- data/asciidoc/tests/data/filters-test.txt +90 -0
- data/asciidoc/tests/data/lang-de-test.txt +106 -0
- data/asciidoc/tests/data/lang-en-test.txt +114 -0
- data/asciidoc/tests/data/lang-es-test.txt +106 -0
- data/asciidoc/tests/data/lang-fr-test.txt +106 -0
- data/asciidoc/tests/data/lang-hu-test.txt +106 -0
- data/asciidoc/tests/data/lang-nl-test.txt +94 -0
- data/asciidoc/tests/data/lang-pt-BR-test.txt +106 -0
- data/asciidoc/tests/data/lang-ru-test.txt +106 -0
- data/asciidoc/tests/data/lang-uk-test.txt +106 -0
- data/asciidoc/tests/data/oldtables.txt +64 -0
- data/asciidoc/tests/data/rcs-id-marker-test.txt +6 -0
- data/asciidoc/tests/data/testcases.conf +2 -0
- data/asciidoc/tests/data/testcases.txt +740 -0
- data/asciidoc/tests/data/utf8-bom-test.txt +9 -0
- data/asciidoc/tests/data/utf8-examples.txt +217 -0
- data/asciidoc/tests/testasciidoc.conf +520 -0
- data/asciidoc/tests/testasciidoc.py +411 -0
- data/asciidoc/text.conf +16 -16
- data/asciidoc/vim/syntax/asciidoc.vim +99 -91
- data/asciidoc/wordpress.conf +43 -3
- data/asciidoc/xhtml11-quirks.conf +61 -57
- data/asciidoc/xhtml11.conf +684 -645
- data/lib/mizuho.rb +2 -0
- data/lib/mizuho/generator.rb +2 -2
- data/test/generator_spec.rb +1 -1
- data/test/parser_spec.rb +1 -1
- data/test/spec_helper.rb +3 -4
- metadata +87 -88
- data/asciidoc/a2x +0 -674
- data/asciidoc/doc/article.css-embedded.html +0 -602
- data/asciidoc/doc/article.html +0 -46
- data/asciidoc/doc/asciidoc-revhistory.xml +0 -27
- data/asciidoc/doc/asciidoc.1.css-embedded.html +0 -598
- data/asciidoc/doc/asciidoc.1.css.html +0 -212
- data/asciidoc/doc/asciidoc.1.html +0 -190
- data/asciidoc/doc/asciidoc.css-embedded.html +0 -7853
- data/asciidoc/doc/asciidoc.css.html +0 -7416
- data/asciidoc/doc/asciidoc.html +0 -3339
- data/asciidoc/doc/book-multi.css-embedded.html +0 -575
- data/asciidoc/doc/book-multi.html +0 -55
- data/asciidoc/doc/book.css-embedded.html +0 -607
- data/asciidoc/doc/book.html +0 -43
- data/asciidoc/doc/docbook-xsl.css +0 -272
- data/asciidoc/doc/latex-backend.html +0 -117
- data/asciidoc/doc/music-filter.html +0 -566
- data/asciidoc/doc/source-highlight-filter.html +0 -214
- data/asciidoc/docbook.conf +0 -721
- data/asciidoc/examples/website/ASCIIMathML.js +0 -938
- data/asciidoc/examples/website/CHANGELOG.html +0 -4389
- data/asciidoc/examples/website/CHANGELOG.txt +0 -1810
- data/asciidoc/examples/website/INSTALL.html +0 -161
- data/asciidoc/examples/website/INSTALL.txt +0 -71
- data/asciidoc/examples/website/LaTeXMathML.js +0 -1223
- data/asciidoc/examples/website/README-website.html +0 -118
- data/asciidoc/examples/website/README-website.txt +0 -29
- data/asciidoc/examples/website/README.html +0 -125
- data/asciidoc/examples/website/README.txt +0 -36
- data/asciidoc/examples/website/a2x.1.html +0 -419
- data/asciidoc/examples/website/a2x.1.txt +0 -204
- data/asciidoc/examples/website/asciidoc-docbook-xsl.html +0 -130
- data/asciidoc/examples/website/asciidoc-docbook-xsl.txt +0 -43
- data/asciidoc/examples/website/asciidoc-graphviz-sample.txt +0 -130
- data/asciidoc/examples/website/asciimathml.txt +0 -64
- data/asciidoc/examples/website/build-website.sh +0 -25
- data/asciidoc/examples/website/customers.csv +0 -18
- data/asciidoc/examples/website/downloads.html +0 -257
- data/asciidoc/examples/website/downloads.txt +0 -121
- data/asciidoc/examples/website/faq.html +0 -673
- data/asciidoc/examples/website/faq.txt +0 -547
- data/asciidoc/examples/website/index.html +0 -419
- data/asciidoc/examples/website/index.txt +0 -245
- data/asciidoc/examples/website/latex-backend.html +0 -535
- data/asciidoc/examples/website/latex-backend.txt +0 -191
- data/asciidoc/examples/website/latexmathml.txt +0 -41
- data/asciidoc/examples/website/layout1.conf +0 -161
- data/asciidoc/examples/website/layout1.css +0 -65
- data/asciidoc/examples/website/layout2.conf +0 -158
- data/asciidoc/examples/website/layout2.css +0 -93
- data/asciidoc/examples/website/manpage.html +0 -266
- data/asciidoc/examples/website/manpage.txt +0 -118
- data/asciidoc/examples/website/music-filter.html +0 -242
- data/asciidoc/examples/website/music-filter.txt +0 -158
- data/asciidoc/examples/website/music1.abc +0 -12
- data/asciidoc/examples/website/music1.png +0 -0
- data/asciidoc/examples/website/music2.ly +0 -9
- data/asciidoc/examples/website/music2.png +0 -0
- data/asciidoc/examples/website/newlists.txt +0 -40
- data/asciidoc/examples/website/newtables.txt +0 -397
- data/asciidoc/examples/website/sample1.png +0 -0
- data/asciidoc/examples/website/sample3.png +0 -0
- data/asciidoc/examples/website/sample4.png +0 -0
- data/asciidoc/examples/website/source-highlight-filter.html +0 -286
- data/asciidoc/examples/website/source-highlight-filter.txt +0 -203
- data/asciidoc/examples/website/support.html +0 -78
- data/asciidoc/examples/website/support.txt +0 -5
- data/asciidoc/examples/website/toc.js +0 -69
- data/asciidoc/examples/website/userguide.html +0 -7460
- data/asciidoc/examples/website/userguide.txt +0 -4979
- data/asciidoc/examples/website/version83.txt +0 -37
- data/asciidoc/examples/website/version9.html +0 -143
- data/asciidoc/examples/website/version9.txt +0 -48
- data/asciidoc/examples/website/xhtml11-quirks.css +0 -41
- data/asciidoc/examples/website/xhtml11.css +0 -328
- data/asciidoc/stylesheets/xhtml11-manpage.css +0 -18
- data/asciidoc/stylesheets/xhtml11.css +0 -328
data/asciidoc/configure.ac
CHANGED
@@ -15,6 +15,30 @@ See dblatex(1) -p option.
|
|
15
15
|
<xsl:param name="table.in.float">0</xsl:param>
|
16
16
|
<xsl:param name="monoseq.hyphenation">0</xsl:param>
|
17
17
|
<xsl:param name="latex.output.revhistory">1</xsl:param>
|
18
|
+
|
19
|
+
<!-- This doesn't work, don't know why, see:
|
20
|
+
http://dblatex.sourceforge.net/html/manual/apas03.html
|
21
|
+
./docbook-xsl/common.xsl
|
22
|
+
-->
|
23
|
+
<!--
|
24
|
+
<xsl:param name="doc.toc.show">
|
25
|
+
<xsl:choose>
|
26
|
+
<xsl:when test="/processing-instruction('asciidoc-toc')">
|
27
|
+
1
|
28
|
+
</xsl:when>
|
29
|
+
<xsl:otherwise>
|
30
|
+
0
|
31
|
+
</xsl:otherwise>
|
32
|
+
</xsl:choose>
|
33
|
+
</xsl:param>
|
34
|
+
<xsl:param name="doc.lot.show">
|
35
|
+
<xsl:choose>
|
36
|
+
<xsl:when test="/book">
|
37
|
+
figure,table,equation,example
|
38
|
+
</xsl:when>
|
39
|
+
</xsl:choose>
|
40
|
+
</xsl:param>
|
41
|
+
-->
|
18
42
|
<xsl:param name="doc.toc.show">1</xsl:param>
|
19
43
|
|
20
44
|
<!--
|
@@ -28,5 +52,23 @@ See dblatex(1) -p option.
|
|
28
52
|
<xsl:text> \end{alltt}</xsl:text>
|
29
53
|
</xsl:template>
|
30
54
|
|
55
|
+
<xsl:template match="processing-instruction('asciidoc-pagebreak')">
|
56
|
+
<!-- force hard pagebreak, varies from 0(low) to 4(high) -->
|
57
|
+
<xsl:text>\pagebreak[4] </xsl:text>
|
58
|
+
<xsl:apply-templates />
|
59
|
+
<xsl:text> </xsl:text>
|
60
|
+
</xsl:template>
|
61
|
+
|
62
|
+
<xsl:template match="processing-instruction('asciidoc-br')">
|
63
|
+
<xsl:text>\newline </xsl:text>
|
64
|
+
</xsl:template>
|
65
|
+
|
66
|
+
<xsl:template match="processing-instruction('asciidoc-hr')">
|
67
|
+
<!-- draw a 444 pt line (centered) -->
|
68
|
+
<xsl:text>\begin{center} </xsl:text>
|
69
|
+
<xsl:text>\line(1,0){444} </xsl:text>
|
70
|
+
<xsl:text>\end{center} </xsl:text>
|
71
|
+
</xsl:template>
|
72
|
+
|
31
73
|
</xsl:stylesheet>
|
32
74
|
|
data/asciidoc/doc/a2x.1
CHANGED
@@ -1,51 +1,67 @@
|
|
1
|
+
'\" t
|
1
2
|
.\" Title: a2x
|
2
|
-
.\" Author:
|
3
|
-
.\" Generator: DocBook XSL Stylesheets v1.
|
4
|
-
.\" Date:
|
5
|
-
.\" Manual:
|
6
|
-
.\" Source:
|
3
|
+
.\" Author: [see the "AUTHOR" section]
|
4
|
+
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
5
|
+
.\" Date: 20 May 2011
|
6
|
+
.\" Manual: \ \&
|
7
|
+
.\" Source: \ \& 8.6.5
|
8
|
+
.\" Language: English
|
7
9
|
.\"
|
8
|
-
.TH "A2X" "1" "
|
10
|
+
.TH "A2X" "1" "20 May 2011" "\ \& 8\&.6\&.5" "\ \&"
|
11
|
+
.\" -----------------------------------------------------------------
|
12
|
+
.\" * Define some portability stuff
|
13
|
+
.\" -----------------------------------------------------------------
|
14
|
+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
15
|
+
.\" http://bugs.debian.org/507673
|
16
|
+
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
17
|
+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
18
|
+
.ie \n(.g .ds Aq \(aq
|
19
|
+
.el .ds Aq '
|
20
|
+
.\" -----------------------------------------------------------------
|
21
|
+
.\" * set default formatting
|
22
|
+
.\" -----------------------------------------------------------------
|
9
23
|
.\" disable hyphenation
|
10
24
|
.nh
|
11
25
|
.\" disable justification (adjust text to left margin only)
|
12
26
|
.ad l
|
27
|
+
.\" -----------------------------------------------------------------
|
28
|
+
.\" * MAIN CONTENT STARTS HERE *
|
29
|
+
.\" -----------------------------------------------------------------
|
13
30
|
.SH "NAME"
|
14
|
-
a2x
|
31
|
+
a2x \- A toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats)
|
15
32
|
.SH "SYNOPSIS"
|
16
|
-
\fBa2x\fR [\fIOPTIONS\fR] \fIFILE\fR
|
17
33
|
.sp
|
34
|
+
\fBa2x\fR [\fIOPTIONS\fR] \fISOURCE_FILE\fR
|
18
35
|
.SH "DESCRIPTION"
|
19
|
-
A DocBook toolchain wrapper script that translates an AsciiDoc text file \fIFILE\fR to PDF, DVI, PS, LaTeX, XHTML (single page or chunked), man page, HTML Help or plain text formats\. PDF, XHTML, man page and HTML Help formats are are generated using the asciidoc(1), xsltproc(1), DocBook XSL Stylesheets, dblatex (or FOP) toolchain\. Plain text is produced by passing asciidoc(1) generated HTML through lynx(1)\. The htmlhelp format option generates \.hhp, \.hhc and \.html files suitable for compilation to an HTML Help \.chm file\.
|
20
36
|
.sp
|
37
|
+
A DocBook toolchain manager that translates an AsciiDoc text file \fISOURCE_FILE\fR to PDF, EPUB, DVI, PS, LaTeX, XHTML (single page or chunked), man page, HTML Help or plain text formats using \fIasciidoc(1)\fR and other applications (see REQUISITES section)\&. \fISOURCE_FILE\fR can also be a DocBook file with an \&.xml extension\&.
|
21
38
|
.SH "OPTIONS"
|
22
39
|
.PP
|
23
40
|
\fB\-a, \-\-attribute\fR=\fIATTRIBUTE\fR
|
24
41
|
.RS 4
|
25
42
|
Set asciidoc(1) attribute value (shortcut for
|
26
43
|
\fB\-\-asciidoc\-opts\fR=\fI"\-a ATTRIBUTE"\fR
|
27
|
-
option)
|
44
|
+
option)\&. This option may be specified more than once\&.
|
28
45
|
.RE
|
29
46
|
.PP
|
30
47
|
\fB\-\-asciidoc\-opts\fR=\fIASCIIDOC_OPTS\fR
|
31
48
|
.RS 4
|
32
|
-
Additional
|
49
|
+
Additional
|
50
|
+
\fIasciidoc(1)\fR
|
51
|
+
options\&. This option may be specified more than once\&.
|
33
52
|
.RE
|
34
53
|
.PP
|
35
|
-
\fB\-\-
|
54
|
+
\fB\-\-conf\-file\fR=\fICONF_FILE\fR
|
36
55
|
.RS 4
|
37
|
-
|
38
|
-
|
39
|
-
\fIchunked\fR,
|
40
|
-
\fIhtmlhelp\fR
|
41
|
-
formats\. The default behavior is to suppress copying\.
|
56
|
+
Load configuration file\&. See
|
57
|
+
CONF FILES section\&.
|
42
58
|
.RE
|
43
59
|
.PP
|
44
|
-
\fB\-D, \-\-destination\-dir\fR=\
|
60
|
+
\fB\-D, \-\-destination\-dir\fR=\fIDESTINATION_DIR\fR
|
45
61
|
.RS 4
|
46
|
-
Output directory
|
47
|
-
\
|
48
|
-
directory
|
62
|
+
Output directory\&. Defaults to
|
63
|
+
\fISOURCE_FILE\fR
|
64
|
+
directory\&.
|
49
65
|
.RE
|
50
66
|
.PP
|
51
67
|
\fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR
|
@@ -54,204 +70,645 @@ DocBook document type:
|
|
54
70
|
\fIarticle\fR,
|
55
71
|
\fImanpage\fR
|
56
72
|
or
|
57
|
-
\fIbook\fR
|
73
|
+
\fIbook\fR\&. Default document type is
|
58
74
|
\fIarticle\fR
|
59
75
|
unless the format is
|
60
76
|
\fImanpage\fR
|
61
77
|
(in which case it defaults to
|
62
|
-
\fImanpage\fR)
|
78
|
+
\fImanpage\fR)\&.
|
63
79
|
.RE
|
64
80
|
.PP
|
65
81
|
\fB\-f, \-\-format\fR=\fIFORMAT\fR
|
66
82
|
.RS 4
|
67
|
-
Output
|
83
|
+
Output formats:
|
68
84
|
\fIchunked\fR,
|
85
|
+
\fIdocbook\fR,
|
69
86
|
\fIdvi\fR,
|
87
|
+
\fIepub\fR,
|
70
88
|
\fIhtmlhelp\fR,
|
71
89
|
\fImanpage\fR,
|
72
|
-
\fIpdf\fR
|
90
|
+
\fIpdf\fR
|
91
|
+
(default),
|
73
92
|
\fIps\fR,
|
74
93
|
\fItex\fR,
|
75
|
-
\fItext\fR
|
76
|
-
|
77
|
-
\fIxhtml\fR\.
|
94
|
+
\fItext\fR,
|
95
|
+
\fIxhtml\fR\&.
|
78
96
|
.RE
|
79
97
|
.PP
|
80
98
|
\fB\-h, \-\-help\fR
|
81
99
|
.RS 4
|
82
|
-
Print command\-line syntax and program options to stdout
|
100
|
+
Print command\-line syntax and program options to stdout\&.
|
83
101
|
.RE
|
84
102
|
.PP
|
85
103
|
\fB\-\-icons\fR
|
86
104
|
.RS 4
|
87
|
-
Use admonition or navigation icon images in output documents
|
105
|
+
Use admonition or navigation icon images in output documents\&. The default behavior is to use text in place of icons\&.
|
88
106
|
.RE
|
89
107
|
.PP
|
90
108
|
\fB\-\-icons\-dir\fR=\fIPATH\fR
|
91
109
|
.RS 4
|
92
|
-
A path (relative to
|
93
|
-
|
94
|
-
\
|
95
|
-
|
96
|
-
|
97
|
-
|
110
|
+
A path (relative to output files) containing admonition and navigation icons\&. Defaults to
|
111
|
+
images/icons\&. The
|
112
|
+
\fI\-\-icons\fR
|
113
|
+
option is implicit if this option is used\&.
|
114
|
+
.RE
|
115
|
+
.PP
|
116
|
+
\fB\-k, \-\-keep\-artifacts\fR
|
117
|
+
.RS 4
|
118
|
+
Do not delete temporary build files\&.
|
119
|
+
.RE
|
120
|
+
.PP
|
121
|
+
\fB\-\-lynx\fR
|
122
|
+
.RS 4
|
123
|
+
Use
|
124
|
+
\fIlynx(1)\fR
|
125
|
+
to generate text formatted output\&. The default behavior is to use
|
126
|
+
\fIw3m(1)\fR\&.
|
98
127
|
.RE
|
99
128
|
.PP
|
100
129
|
\fB\-L, \-\-no\-xmllint\fR
|
101
130
|
.RS 4
|
102
|
-
|
103
|
-
\fIxmllint(1)\fR
|
131
|
+
Do not check asciidoc output with
|
132
|
+
\fIxmllint(1)\fR\&.
|
133
|
+
.RE
|
134
|
+
.PP
|
135
|
+
\fB\-\-\-epubcheck\fR
|
136
|
+
.RS 4
|
137
|
+
Check EPUB output with
|
138
|
+
\fIepubcheck(1)\fR\&.
|
104
139
|
.RE
|
105
140
|
.PP
|
106
141
|
\fB\-n, \-\-dry\-run\fR
|
107
142
|
.RS 4
|
108
|
-
|
143
|
+
Do not do anything just print what would have been done\&.
|
109
144
|
.RE
|
110
145
|
.PP
|
111
|
-
\fB\-
|
146
|
+
\fB\-r, \-\-resource\fR=\fIRESOURCE_SPEC\fR
|
112
147
|
.RS 4
|
113
|
-
|
114
|
-
\
|
148
|
+
Specify a resource\&. This option may be specified more than once\&. See the
|
149
|
+
\fBRESOURCES\fR
|
150
|
+
section for more details\&.
|
115
151
|
.RE
|
116
152
|
.PP
|
117
|
-
\fB\-\-
|
153
|
+
\fB\-m, \-\-resource\-manifest\fR=\fIFILE\fR
|
118
154
|
.RS 4
|
119
|
-
|
120
|
-
\
|
155
|
+
|
156
|
+
\fIFILE\fR
|
157
|
+
contains a list resources (one per line)\&. Manifest
|
158
|
+
\fIFILE\fR
|
159
|
+
entries are formatted just like
|
160
|
+
\fB\-\-resource\fR
|
161
|
+
option arguments\&. Environment variables and tilde home directories are allowed\&.
|
162
|
+
.RE
|
163
|
+
.PP
|
164
|
+
\fB\-\-stylesheet\fR=\fISTYLESHEET\fR
|
165
|
+
.RS 4
|
166
|
+
A space delimited list of one or more CSS stylesheet file names that are used to style HTML output generated by DocBook XSL Stylesheets\&. Defaults to
|
167
|
+
\fIdocbook\-xsl\&.css\fR\&. The stylesheets are processed in list order\&. The stylesheets must reside in a valid
|
168
|
+
resource file
|
169
|
+
location\&. Applies to HTML formats:
|
121
170
|
\fIxhtml\fR,
|
171
|
+
\fIepub\fR,
|
122
172
|
\fIchunked\fR,
|
123
173
|
\fIhtmlhelp\fR
|
124
|
-
formats
|
174
|
+
formats\&.
|
125
175
|
.RE
|
126
176
|
.PP
|
127
177
|
\fB\-v, \-\-verbose\fR
|
128
178
|
.RS 4
|
129
|
-
Print operational details to stderr
|
179
|
+
Print operational details to stderr\&. A second
|
130
180
|
\fB\-v\fR
|
131
|
-
option applies the verbose option to toolchain commands
|
181
|
+
option applies the verbose option to toolchain commands\&.
|
132
182
|
.RE
|
133
183
|
.PP
|
134
184
|
\fB\-\-version\fR
|
135
185
|
.RS 4
|
136
|
-
Print program version to stdout
|
186
|
+
Print program version to stdout\&.
|
137
187
|
.RE
|
138
188
|
.PP
|
139
189
|
\fB\-\-xsltproc\-opts\fR=\fIXSLTPROC_OPTS\fR
|
140
190
|
.RS 4
|
141
|
-
Additional
|
191
|
+
Additional
|
192
|
+
\fIxsltproc(1)\fR
|
193
|
+
options\&. This option may be specified more than once\&.
|
194
|
+
.RE
|
195
|
+
.PP
|
196
|
+
\fB\-\-xsl\-file\fR=\fIXSL_FILE\fR
|
197
|
+
.RS 4
|
198
|
+
Override the built\-in XSL stylesheet with the custom XSL stylesheet
|
199
|
+
\fIXSL_FILE\fR\&.
|
142
200
|
.RE
|
143
201
|
.PP
|
144
202
|
\fB\-\-fop\fR
|
145
203
|
.RS 4
|
146
|
-
Use FOP to generate PDFs
|
204
|
+
Use FOP to generate PDFs\&. The default behavior is to use
|
205
|
+
\fIdblatex(1)\fR\&. The
|
206
|
+
\fI\-\-fop\fR
|
207
|
+
option is implicit if this option is used\&.
|
147
208
|
.RE
|
148
209
|
.PP
|
149
210
|
\fB\-\-fop\-opts\fR=\fIFOP_OPTS\fR
|
150
211
|
.RS 4
|
151
|
-
Additional
|
212
|
+
Additional
|
213
|
+
\fIfop(1)\fR
|
214
|
+
options\&. If this option is specified FOP is used to generate PDFs\&. This option may be specified more than once\&.
|
152
215
|
.RE
|
153
216
|
.PP
|
154
217
|
\fB\-\-dblatex\-opts\fR=\fIDBLATEX_OPTS\fR
|
155
218
|
.RS 4
|
156
|
-
Additional
|
219
|
+
Additional
|
220
|
+
\fIdblatex(1)\fR
|
221
|
+
options\&. This option may be specified more than once\&.
|
222
|
+
.RE
|
223
|
+
.sp
|
224
|
+
Options can also be set in the AsciiDoc source file\&. If \fISOURCE_FILE\fR contains a comment line beginning with \fB// a2x:\fR then the remainder of the line will be treated as \fIa2x\fR command\-line options\&. For example:
|
225
|
+
.sp
|
226
|
+
.if n \{\
|
227
|
+
.RS 4
|
228
|
+
.\}
|
229
|
+
.nf
|
230
|
+
// a2x default options\&.
|
231
|
+
// a2x: \-dbook \-\-epubcheck
|
232
|
+
// Suppress revision history in dblatex outputs\&.
|
233
|
+
// a2x: \-\-dblatex\-opts "\-P latex\&.output\&.revhistory=0"
|
234
|
+
.fi
|
235
|
+
.if n \{\
|
236
|
+
.RE
|
237
|
+
.\}
|
238
|
+
.sp
|
239
|
+
.RS 4
|
240
|
+
.ie n \{\
|
241
|
+
\h'-04'\(bu\h'+03'\c
|
242
|
+
.\}
|
243
|
+
.el \{\
|
244
|
+
.sp -1
|
245
|
+
.IP \(bu 2.3
|
246
|
+
.\}
|
247
|
+
Options spanning multiple such comment lines will be concatenated\&.
|
248
|
+
.RE
|
249
|
+
.sp
|
250
|
+
.RS 4
|
251
|
+
.ie n \{\
|
252
|
+
\h'-04'\(bu\h'+03'\c
|
253
|
+
.\}
|
254
|
+
.el \{\
|
255
|
+
.sp -1
|
256
|
+
.IP \(bu 2.3
|
257
|
+
.\}
|
258
|
+
Zero or more white space characters can appear between the leading
|
259
|
+
\fB//\fR
|
260
|
+
and
|
261
|
+
\fBa2x:\fR\&.
|
262
|
+
.RE
|
263
|
+
.sp
|
264
|
+
.RS 4
|
265
|
+
.ie n \{\
|
266
|
+
\h'-04'\(bu\h'+03'\c
|
267
|
+
.\}
|
268
|
+
.el \{\
|
269
|
+
.sp -1
|
270
|
+
.IP \(bu 2.3
|
271
|
+
.\}
|
272
|
+
Command\-line options take precedence over options set in the source file\&.
|
157
273
|
.RE
|
158
274
|
.SH "OUTPUT FILES"
|
159
|
-
Output files are written to the directory specified by the \fB\-\-destination\-dir\fR option\. If no \fB\-\-destination\-dir\fR option is set output files are written to the source FILE directory\.
|
160
275
|
.sp
|
161
|
-
Output files
|
276
|
+
Output files are written to the directory specified by the \fB\-\-destination\-dir\fR option\&. If no \fB\-\-destination\-dir\fR option is set output files are written to the \fISOURCE_FILE\fR directory\&.
|
277
|
+
.sp
|
278
|
+
Output files have the same name as the \fISOURCE_FILE\fR but with an appropriate file name extension: \&.html for \fIxhtml\fR; \&.epub for \fIepub\fR; \&.hhp for \fIhtmlhelp\fR; \&.pdf for \fIpdf\fR; \&.text for \fItext\fR, \&.xml for \fIdocbook\fR\&. 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\&.
|
162
279
|
.sp
|
163
|
-
Same named existing files are overwritten
|
280
|
+
Same named existing files are overwritten\&.
|
281
|
+
.sp
|
282
|
+
In addition to generating HTML files the \fIxhtml\fR, \fIepub\fR, \fIchunked\fR and \fIhtmlhelp\fR formats ensure resource files are copied to their correct destination directory locations\&.
|
283
|
+
.SH "RESOURCES"
|
284
|
+
.sp
|
285
|
+
Resources are files (typically CSS and images) that are required by HTML based outputs (\fIxhtml\fR, \fIepub\fR, \fIchunked\fR, \fIhtmlhelp\fR formats)\&. \fIa2x\fR scans the generated HTML files and builds a list of required CSS and image files\&. Additional resource files can be specified explicitly using the \fB\-\-resource\fR option\&.
|
286
|
+
.sp
|
287
|
+
\fIa2x\fR searches for resource files in the following locations in the following order:
|
288
|
+
.sp
|
289
|
+
.RS 4
|
290
|
+
.ie n \{\
|
291
|
+
\h'-04' 1.\h'+01'\c
|
292
|
+
.\}
|
293
|
+
.el \{\
|
294
|
+
.sp -1
|
295
|
+
.IP " 1." 4.2
|
296
|
+
.\}
|
297
|
+
The
|
298
|
+
\fISOURCE_FILE\fR
|
299
|
+
directory\&.
|
300
|
+
.RE
|
301
|
+
.sp
|
302
|
+
.RS 4
|
303
|
+
.ie n \{\
|
304
|
+
\h'-04' 2.\h'+01'\c
|
305
|
+
.\}
|
306
|
+
.el \{\
|
307
|
+
.sp -1
|
308
|
+
.IP " 2." 4.2
|
309
|
+
.\}
|
310
|
+
Resource directories specified by the
|
311
|
+
\fB\-\-resource\fR
|
312
|
+
option (searched recursively)\&.
|
313
|
+
.RE
|
314
|
+
.sp
|
315
|
+
.RS 4
|
316
|
+
.ie n \{\
|
317
|
+
\h'-04' 3.\h'+01'\c
|
318
|
+
.\}
|
319
|
+
.el \{\
|
320
|
+
.sp -1
|
321
|
+
.IP " 3." 4.2
|
322
|
+
.\}
|
323
|
+
Resource directories specified by the
|
324
|
+
\fB\-\-resource\-manifest\fR
|
325
|
+
option (searched recursively in the order they appear in the manifest file)\&.
|
326
|
+
.RE
|
327
|
+
.sp
|
328
|
+
.RS 4
|
329
|
+
.ie n \{\
|
330
|
+
\h'-04' 4.\h'+01'\c
|
331
|
+
.\}
|
332
|
+
.el \{\
|
333
|
+
.sp -1
|
334
|
+
.IP " 4." 4.2
|
335
|
+
.\}
|
336
|
+
The stock
|
337
|
+
images
|
338
|
+
and
|
339
|
+
stylesheets
|
340
|
+
directories in the
|
341
|
+
\fIasciidoc(1)\fR
|
342
|
+
configuration files directories (searched recursively)\&.
|
343
|
+
.RE
|
344
|
+
.sp
|
345
|
+
.RS 4
|
346
|
+
.ie n \{\
|
347
|
+
\h'-04' 5.\h'+01'\c
|
348
|
+
.\}
|
349
|
+
.el \{\
|
350
|
+
.sp -1
|
351
|
+
.IP " 5." 4.2
|
352
|
+
.\}
|
353
|
+
The destination directory\&.
|
354
|
+
.RE
|
355
|
+
.sp
|
356
|
+
When a resource file is found it is copied to the correct relative destination directory\&. Missing destination sub\-directories are created automatically\&.
|
357
|
+
.sp
|
358
|
+
There are two distinct mechanisms for specifying additional resources:
|
359
|
+
.sp
|
360
|
+
.RS 4
|
361
|
+
.ie n \{\
|
362
|
+
\h'-04' 1.\h'+01'\c
|
363
|
+
.\}
|
364
|
+
.el \{\
|
365
|
+
.sp -1
|
366
|
+
.IP " 1." 4.2
|
367
|
+
.\}
|
368
|
+
A resource directory which will be searched recursively for missing resource files\&.
|
369
|
+
.RE
|
370
|
+
.sp
|
371
|
+
.RS 4
|
372
|
+
.ie n \{\
|
373
|
+
\h'-04' 2.\h'+01'\c
|
374
|
+
.\}
|
375
|
+
.el \{\
|
376
|
+
.sp -1
|
377
|
+
.IP " 2." 4.2
|
378
|
+
.\}
|
379
|
+
A resource file which will be copied to the output destination directory\&.
|
380
|
+
.RE
|
164
381
|
.sp
|
165
|
-
|
382
|
+
Resources are specified with \fB\-\-resource\fR option values which can be one of the following formats:
|
166
383
|
.sp
|
167
|
-
|
384
|
+
.if n \{\
|
385
|
+
.RS 4
|
386
|
+
.\}
|
387
|
+
.nf
|
388
|
+
<resource_dir>
|
389
|
+
<resource_file>[=<destination_file>]
|
390
|
+
\&.<ext>=<mimetype>
|
391
|
+
.fi
|
392
|
+
.if n \{\
|
393
|
+
.RE
|
394
|
+
.\}
|
168
395
|
.sp
|
169
|
-
|
396
|
+
Where:
|
397
|
+
.PP
|
398
|
+
<resource_dir>
|
399
|
+
.RS 4
|
400
|
+
Specifies a directory (absolute or relative to the
|
401
|
+
\fISOURCE_FILE\fR) which is searched recursively for missing resource files\&. To eliminate ambiguity the
|
402
|
+
<resource_dir>
|
403
|
+
name should end with a directory separator character\&.
|
404
|
+
.RE
|
405
|
+
.PP
|
406
|
+
<resource_file>
|
407
|
+
.RS 4
|
408
|
+
Specifies a resource file (absolute or relative to the
|
409
|
+
\fISOURCE_FILE\fR) which will be copied to
|
410
|
+
<destination_file>\&. If
|
411
|
+
<destination_file>
|
412
|
+
is not specified then it is the same as the
|
413
|
+
<resource_file>\&.
|
414
|
+
.RE
|
415
|
+
.PP
|
416
|
+
<destination_file>
|
417
|
+
.RS 4
|
418
|
+
Specifies the destination of the copied source file\&. The
|
419
|
+
<destination_file>
|
420
|
+
path is relative to the destination directory (absolute paths are not allowed)\&. The location of the destination directory depends on the output
|
421
|
+
\fIFORMAT\fR
|
422
|
+
(see the
|
423
|
+
\fBOUTPUT FILES\fR
|
424
|
+
section for details):
|
425
|
+
.PP
|
426
|
+
chunked, htmlhelp
|
427
|
+
.RS 4
|
428
|
+
The chunked output directory\&.
|
429
|
+
.RE
|
430
|
+
.PP
|
431
|
+
epub
|
432
|
+
.RS 4
|
433
|
+
The archived
|
434
|
+
OEBPS
|
435
|
+
directory\&.
|
436
|
+
.RE
|
437
|
+
.PP
|
438
|
+
xhtml
|
439
|
+
.RS 4
|
440
|
+
The output
|
441
|
+
\fBDESTINATION_DIR\fR\&.
|
442
|
+
.RE
|
443
|
+
.RE
|
444
|
+
.PP
|
445
|
+
\&.<ext>=<mimetype>
|
446
|
+
.RS 4
|
447
|
+
When adding resources to EPUB files the mimetype is inferred from the
|
448
|
+
<destination file>
|
449
|
+
extension, if the mimetype cannot be guessed an error occurs\&. The
|
450
|
+
\&.<ext>=<mimetype>
|
451
|
+
resource syntax can be used to explicitly set mimetypes\&.
|
452
|
+
<ext>
|
453
|
+
is the file name extension,
|
454
|
+
<mimetype>
|
455
|
+
is the corresponding MIME type\&.
|
456
|
+
.RE
|
170
457
|
.sp
|
171
|
-
|
458
|
+
Resource option examples:
|
172
459
|
.sp
|
460
|
+
.if n \{\
|
461
|
+
.RS 4
|
462
|
+
.\}
|
463
|
+
.nf
|
464
|
+
\-\-resource \&.\&./images/
|
465
|
+
\-\-resource doc/README\&.txt=README\&.txt
|
466
|
+
\-\-resource ~/images/tiger\&.png=images/tiger\&.png
|
467
|
+
\-\-resource \&.ttf=application/x\-font\-ttf
|
468
|
+
.fi
|
469
|
+
.if n \{\
|
470
|
+
.RE
|
471
|
+
.\}
|
173
472
|
.SH "EXAMPLES"
|
174
473
|
.PP
|
175
|
-
a2x \-f pdf doc/source\-highlight\-filter
|
474
|
+
a2x \-f pdf doc/source\-highlight\-filter\&.txt
|
176
475
|
.RS 4
|
177
|
-
Generates
|
476
|
+
Generates
|
477
|
+
doc/source\-highlight\-filter\&.pdf
|
478
|
+
file\&.
|
178
479
|
.RE
|
179
480
|
.PP
|
180
|
-
a2x \-f
|
481
|
+
a2x \-f xhtml \-D \&.\&./doc \-\-icons \-r \&.\&./images/ team\&.txt
|
181
482
|
.RS 4
|
182
|
-
Creates
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
stylesheet to the
|
187
|
-
\.\./webpages/guide\.chunked
|
188
|
-
directory plus admonition and navigation icons to the
|
189
|
-
\.\./webpages/guide\.chunked/images/icons
|
190
|
-
directory\.
|
483
|
+
Creates HTML file
|
484
|
+
\&.\&./doc/team\&.html, uses admonition icons and recursively searches the
|
485
|
+
\&.\&./images/
|
486
|
+
directory for any missing resources\&.
|
191
487
|
.RE
|
192
|
-
.SH "REQUISITES"
|
193
|
-
This script runs under the bash(1) shell and requires the following programs (which may or may not be prepackaged with your Linux distribution):
|
194
488
|
.PP
|
195
|
-
|
489
|
+
a2x \-f manpage doc/asciidoc\&.1\&.txt
|
490
|
+
.RS 4
|
491
|
+
Generate
|
492
|
+
doc/asciidoc\&.1
|
493
|
+
manpage\&.
|
494
|
+
.RE
|
495
|
+
.SH "REQUISITES"
|
496
|
+
.sp
|
497
|
+
\fIa2x\fR uses the following programs:
|
498
|
+
.sp
|
196
499
|
.RS 4
|
500
|
+
.ie n \{\
|
501
|
+
\h'-04'\(bu\h'+03'\c
|
502
|
+
.\}
|
503
|
+
.el \{\
|
504
|
+
.sp -1
|
505
|
+
.IP \(bu 2.3
|
506
|
+
.\}
|
197
507
|
|
198
|
-
|
508
|
+
\fBAsciidoc\fR:
|
509
|
+
http://www\&.methods\&.co\&.nz/asciidoc/
|
199
510
|
.RE
|
200
|
-
.
|
201
|
-
xsltproc
|
511
|
+
.sp
|
202
512
|
.RS 4
|
513
|
+
.ie n \{\
|
514
|
+
\h'-04'\(bu\h'+03'\c
|
515
|
+
.\}
|
516
|
+
.el \{\
|
517
|
+
.sp -1
|
518
|
+
.IP \(bu 2.3
|
519
|
+
.\}
|
203
520
|
|
204
|
-
|
521
|
+
\fBxsltproc\fR: (all formats except text):
|
522
|
+
http://xmlsoft\&.org/XSLT/
|
205
523
|
.RE
|
206
|
-
.
|
207
|
-
DocBook XSL Stylesheets
|
524
|
+
.sp
|
208
525
|
.RS 4
|
526
|
+
.ie n \{\
|
527
|
+
\h'-04'\(bu\h'+03'\c
|
528
|
+
.\}
|
529
|
+
.el \{\
|
530
|
+
.sp -1
|
531
|
+
.IP \(bu 2.3
|
532
|
+
.\}
|
209
533
|
|
210
|
-
|
534
|
+
\fBDocBook XSL Stylesheets\fR
|
535
|
+
(all formats except text):
|
536
|
+
http://docbook\&.sourceforge\&.net/projects/xsl/
|
211
537
|
.RE
|
212
|
-
.
|
213
|
-
dblatex (for PDF, DVI, PostScript and LaTeX file generation)
|
538
|
+
.sp
|
214
539
|
.RS 4
|
540
|
+
.ie n \{\
|
541
|
+
\h'-04'\(bu\h'+03'\c
|
542
|
+
.\}
|
543
|
+
.el \{\
|
544
|
+
.sp -1
|
545
|
+
.IP \(bu 2.3
|
546
|
+
.\}
|
215
547
|
|
216
|
-
|
548
|
+
\fBdblatex\fR
|
549
|
+
(pdf, dvi, ps, tex formats):
|
550
|
+
http://dblatex\&.sourceforge\&.net/
|
217
551
|
.RE
|
218
|
-
.
|
219
|
-
FOP (alternative PDF file generation)
|
552
|
+
.sp
|
220
553
|
.RS 4
|
554
|
+
.ie n \{\
|
555
|
+
\h'-04'\(bu\h'+03'\c
|
556
|
+
.\}
|
557
|
+
.el \{\
|
558
|
+
.sp -1
|
559
|
+
.IP \(bu 2.3
|
560
|
+
.\}
|
221
561
|
|
222
|
-
|
562
|
+
\fBFOP\fR
|
563
|
+
(pdf format \(em alternative PDF file generator):
|
564
|
+
http://xmlgraphics\&.apache\&.org/fop/
|
223
565
|
.RE
|
224
|
-
.
|
225
|
-
w3m (text file generation)
|
566
|
+
.sp
|
226
567
|
.RS 4
|
568
|
+
.ie n \{\
|
569
|
+
\h'-04'\(bu\h'+03'\c
|
570
|
+
.\}
|
571
|
+
.el \{\
|
572
|
+
.sp -1
|
573
|
+
.IP \(bu 2.3
|
574
|
+
.\}
|
227
575
|
|
228
|
-
|
576
|
+
\fBw3m\fR
|
577
|
+
(text format):
|
578
|
+
http://w3m\&.sourceforge\&.net/index\&.en\&.html
|
229
579
|
.RE
|
230
|
-
.
|
231
|
-
Lynx (used for text file generation if w3m(1) not installed)
|
580
|
+
.sp
|
232
581
|
.RS 4
|
582
|
+
.ie n \{\
|
583
|
+
\h'-04'\(bu\h'+03'\c
|
584
|
+
.\}
|
585
|
+
.el \{\
|
586
|
+
.sp -1
|
587
|
+
.IP \(bu 2.3
|
588
|
+
.\}
|
233
589
|
|
234
|
-
|
590
|
+
\fBLynx\fR
|
591
|
+
(text format \(em alternative text file generator):
|
592
|
+
http://lynx\&.isc\&.org/
|
235
593
|
.RE
|
236
|
-
See also the latest README file\.
|
237
594
|
.sp
|
238
|
-
.
|
595
|
+
.RS 4
|
596
|
+
.ie n \{\
|
597
|
+
\h'-04'\(bu\h'+03'\c
|
598
|
+
.\}
|
599
|
+
.el \{\
|
600
|
+
.sp -1
|
601
|
+
.IP \(bu 2.3
|
602
|
+
.\}
|
603
|
+
|
604
|
+
\fBepubcheck\fR
|
605
|
+
(epub format \(em EPUB file validator):
|
606
|
+
http://code\&.google\&.com/p/epubcheck/
|
607
|
+
.RE
|
608
|
+
.sp
|
609
|
+
See also the latest README file\&.
|
610
|
+
.SH "CONF FILES"
|
611
|
+
.sp
|
612
|
+
A configuration file contains executable Python code that overrides the global configuration parameters in a2x\&.py\&. Optional configuration files are loaded in the following order:
|
239
613
|
.sp
|
240
614
|
.RS 4
|
241
|
-
\
|
615
|
+
.ie n \{\
|
616
|
+
\h'-04' 1.\h'+01'\c
|
617
|
+
.\}
|
618
|
+
.el \{\
|
619
|
+
.sp -1
|
620
|
+
.IP " 1." 4.2
|
621
|
+
.\}
|
622
|
+
|
623
|
+
a2x\&.conf
|
624
|
+
from the directory containing the
|
625
|
+
\fIa2x\&.py\fR
|
626
|
+
executable\&.
|
627
|
+
.RE
|
628
|
+
.sp
|
629
|
+
.RS 4
|
630
|
+
.ie n \{\
|
631
|
+
\h'-04' 2.\h'+01'\c
|
632
|
+
.\}
|
633
|
+
.el \{\
|
634
|
+
.sp -1
|
635
|
+
.IP " 2." 4.2
|
636
|
+
.\}
|
637
|
+
|
638
|
+
a2x\&.conf
|
639
|
+
from the AsciiDoc global configuration directory\&. Skip this step if we are executing a locally installed (non system wide) copy\&.
|
640
|
+
.RE
|
641
|
+
.sp
|
642
|
+
.RS 4
|
643
|
+
.ie n \{\
|
644
|
+
\h'-04' 3.\h'+01'\c
|
645
|
+
.\}
|
646
|
+
.el \{\
|
647
|
+
.sp -1
|
648
|
+
.IP " 3." 4.2
|
649
|
+
.\}
|
650
|
+
|
651
|
+
a2x\&.conf
|
652
|
+
from the AsciiDoc
|
653
|
+
$HOME/\&.asciidoc
|
654
|
+
configuration directory\&.
|
655
|
+
.RE
|
656
|
+
.sp
|
657
|
+
.RS 4
|
658
|
+
.ie n \{\
|
659
|
+
\h'-04' 4.\h'+01'\c
|
660
|
+
.\}
|
661
|
+
.el \{\
|
662
|
+
.sp -1
|
663
|
+
.IP " 4." 4.2
|
664
|
+
.\}
|
665
|
+
The
|
666
|
+
\fICONF_FILE\fR
|
667
|
+
specified in the
|
668
|
+
\fI\-\-conf\-file\fR
|
669
|
+
option\&.
|
242
670
|
.RE
|
243
671
|
.sp
|
672
|
+
Here are the default configuration file option values:
|
673
|
+
.sp
|
674
|
+
.if n \{\
|
244
675
|
.RS 4
|
245
|
-
|
676
|
+
.\}
|
677
|
+
.nf
|
678
|
+
# Optional environment variable dictionary passed to
|
679
|
+
# executing programs\&. If set to None the existing
|
680
|
+
# environment is used\&.
|
681
|
+
ENV = None
|
682
|
+
|
683
|
+
# External executables\&.
|
684
|
+
ASCIIDOC = \*(Aqasciidoc\*(Aq
|
685
|
+
XSLTPROC = \*(Aqxsltproc\*(Aq
|
686
|
+
DBLATEX = \*(Aqdblatex\*(Aq # pdf generation\&.
|
687
|
+
FOP = \*(Aqfop\*(Aq # pdf generation (\-\-fop option)\&.
|
688
|
+
W3M = \*(Aqw3m\*(Aq # text generation\&.
|
689
|
+
LYNX = \*(Aqlynx\*(Aq # text generation (if no w3m)\&.
|
690
|
+
XMLLINT = \*(Aqxmllint\*(Aq # Set to \*(Aq\*(Aq to disable\&.
|
691
|
+
EPUBCHECK = \*(Aqepubcheck\*(Aq # Set to \*(Aq\*(Aq to disable\&.
|
692
|
+
# External executable default options\&.
|
693
|
+
ASCIIDOC_OPTS = \*(Aq\*(Aq
|
694
|
+
DBLATEX_OPTS = \*(Aq\*(Aq
|
695
|
+
FOP_OPTS = \*(Aq\*(Aq
|
696
|
+
XSLTPROC_OPTS = \*(Aq\*(Aq
|
697
|
+
.fi
|
698
|
+
.if n \{\
|
246
699
|
.RE
|
700
|
+
.\}
|
701
|
+
.SH "BUGS"
|
702
|
+
.sp
|
703
|
+
See the AsciiDoc distribution BUGS file\&.
|
247
704
|
.SH "AUTHOR"
|
248
|
-
Written by Stuart Rackham, <srackham@gmail\.com>
|
249
705
|
.sp
|
706
|
+
a2x was originally written by Stuart Rackham\&. Many people have contributed to it\&.
|
250
707
|
.SH "RESOURCES"
|
251
|
-
SourceForge: http://sourceforge\.net/projects/asciidoc/
|
252
708
|
.sp
|
253
|
-
|
709
|
+
SourceForge: http://sourceforge\&.net/projects/asciidoc/
|
254
710
|
.sp
|
711
|
+
Main web site: http://www\&.methods\&.co\&.nz/asciidoc/
|
255
712
|
.SH "COPYING"
|
256
|
-
Copyright (C) 2002\-2008 Stuart Rackham\. Free use of this software is granted under the terms of the GNU General Public License (GPL)\.
|
257
713
|
.sp
|
714
|
+
Copyright (C) 2002\-2011 Stuart Rackham\&. Free use of this software is granted under the terms of the MIT license\&.
|