1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.0.0a2" />
<title>A2X(1)</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./asciidoc-manpage.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
<script type="text/javascript" src="./asciidoc.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install();
/*]]>*/
</script>
</head>
<body style="max-width:70em">
<div id="layout-menu-box">
<div id="layout-menu">
<div>»<a href="index.html">Home</a></div>
<div>»<a href="userguide.html">User Guide</a></div>
<div>»<a href="INSTALL.html">Installation</a></div>
<div>»<a href="faq.html">FAQ</a></div>
<div>»<a href="manpage.html">asciidoc(1)</a></div>
<div>»<a href="a2x.1.html">a2x(1)</a></div>
<div>»<a href="asciidocapi.html">API</a></div>
<div>»<a href="plugins.html">Plugins</a></div>
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
<div>»<a href="testasciidoc.html">Tests</a></div>
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
<div>»<a href="support.html">Support</a></div>
<div id="page-source">»<a href="a2x.1.txt">Page Source</a></div>
</div>
</div>
<div id="layout-content-box">
<div id="layout-banner">
<div id="layout-title">AsciiDoc</div>
<div id="layout-description">Text based document generation</div>
</div>
<div id="layout-content">
<div id="header">
<h1>
A2X(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>a2x -
A toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats)
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p><strong>a2x</strong> [<em>OPTIONS</em>] <em>SOURCE_FILE</em></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>A DocBook toolchain manager that translates an AsciiDoc text file
<em>SOURCE_FILE</em> to PDF, EPUB, DVI, PS, LaTeX, XHTML (single page or
chunked), man page, HTML Help or plain text formats using
<em><code>asciidoc(1)</code></em> and other applications (see <a href="#X1">REQUISITES section</a>).
<em>SOURCE_FILE</em> can also be a DocBook file with an .xml extension.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>-a, --attribute</strong>=<em>ATTRIBUTE</em>
</dt>
<dd>
<p>
Set <code>asciidoc(1)</code> attribute value (shortcut for <strong>--asciidoc-opts</strong>=<em>"-a
ATTRIBUTE"</em> option).
This option may be specified more than once.
</p>
</dd>
<dt class="hdlist1">
<strong>--asciidoc-opts</strong>=<em>ASCIIDOC_OPTS</em>
</dt>
<dd>
<p>
Additional <em><code>asciidoc(1)</code></em> options.
This option may be specified more than once.
</p>
</dd>
<dt class="hdlist1">
<strong>--conf-file</strong>=<em>CONF_FILE</em>
</dt>
<dd>
<p>
Load configuration file. See <a href="#X2">CONF FILES section</a>.
</p>
</dd>
<dt class="hdlist1">
<strong>-D, --destination-dir</strong>=<em>DESTINATION_DIR</em>
</dt>
<dd>
<p>
Output directory. Defaults to <em>SOURCE_FILE</em> directory. This option
is only applicable to HTML and manpage based output formats (<em>chunked</em>, <em>epub</em>,
<em>htmlhelp</em>, <em>xhtml</em>, <em>manpage</em>).
</p>
</dd>
<dt class="hdlist1">
<strong>-d, --doctype</strong>=<em>DOCTYPE</em>
</dt>
<dd>
<p>
DocBook document type: <em>article</em>, <em>manpage</em> or <em>book</em>. Default
document type is <em>article</em> unless the format is <em>manpage</em> (in which
case it defaults to <em>manpage</em>).
</p>
</dd>
<dt class="hdlist1">
<strong>-b, --backend</strong>=<em>BACKEND</em>
</dt>
<dd>
<p>
<em>BACKEND</em> is the name of an installed backend plugin. When this
option is specified <em>a2x</em> attempts to load a file name <em>a2x-backend.py</em>
from the <em>BACKEND</em> plugin directory. It then converts the
<em>SOURCE_FILE</em> to a <em>BACKEND</em> formatted output file using a global
function defined in <em>a2x-backend.py</em> called <em>to_BACKEND</em>.
</p>
</dd>
<dt class="hdlist1">
<strong>-f, --format</strong>=<em>FORMAT</em>
</dt>
<dd>
<p>
Output formats: <em>chunked</em>, <em>docbook</em>, <em>dvi</em>, <em>epub</em>, <em>htmlhelp</em>,
<em>manpage</em>, <em>pdf</em> (default), <em>ps</em>, <em>tex</em>, <em>text</em>, <em>xhtml</em>.
The AsciiDoc <em>a2x-format</em> attribute value is set to <em>FORMAT</em>.
</p>
</dd>
<dt class="hdlist1">
<strong>-h, --help</strong>
</dt>
<dd>
<p>
Print command-line syntax and program options to stdout.
</p>
</dd>
<dt class="hdlist1">
<strong>--icons</strong>
</dt>
<dd>
<p>
Use admonition or navigation icon images in output documents. The
default behavior is to use text in place of icons.
</p>
</dd>
<dt class="hdlist1">
<strong>--icons-dir</strong>=<em>PATH</em>
</dt>
<dd>
<p>
A path (relative to output files) containing admonition
and navigation icons. Defaults to <code>images/icons</code>.
The <em>--icons</em> option is implicit if this option is used.
</p>
</dd>
<dt class="hdlist1">
<strong>-k, --keep-artifacts</strong>
</dt>
<dd>
<p>
Do not delete temporary build files.
</p>
</dd>
<dt class="hdlist1">
<strong>--lynx</strong>
</dt>
<dd>
<p>
Use <em>lynx(1)</em> (actually: the text-based browser defined by the <code>LYNX</code> config
variable) when generating text formatted output. The default behavior is to
use <em>w3m(1)</em> (actually: the text-based browser defined by the <code>W3M</code> config
variable).
</p>
</dd>
<dt class="hdlist1">
<strong>-L, --no-xmllint</strong>
</dt>
<dd>
<p>
Do not check asciidoc output with <em>xmllint(1)</em>.
</p>
</dd>
<dt class="hdlist1">
<strong>---epubcheck</strong>
</dt>
<dd>
<p>
Check EPUB output with <em>epubcheck(1)</em>.
</p>
</dd>
<dt class="hdlist1">
<strong>-n, --dry-run</strong>
</dt>
<dd>
<p>
Do not do anything just print what would have been done.
</p>
</dd>
<dt class="hdlist1">
<strong>-r, --resource</strong>=<em>RESOURCE_SPEC</em>
</dt>
<dd>
<p>
Specify a resource. This option may be specified more than once.
See the <a href="#X3"><strong>RESOURCES</strong></a> section for more details.
</p>
</dd>
<dt class="hdlist1">
<strong>-m, --resource-manifest</strong>=<em>FILE</em>
</dt>
<dd>
<p>
<em>FILE</em> contains a list resources (one per line). Manifest <em>FILE</em>
entries are formatted just like <strong>--resource</strong> option arguments.
Environment variables and tilde home directories are allowed.
</p>
</dd>
<dt class="hdlist1">
<strong>--stylesheet</strong>=<em>STYLESHEET</em>
</dt>
<dd>
<p>
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 <em>docbook-xsl.css</em>. The stylesheets are processed in
list order. The stylesheets must reside in a valid <a href="#X3">resource file</a> location. Applies to HTML formats: <em>xhtml</em>, <em>epub</em>,
<em>chunked</em>, <em>htmlhelp</em> formats.
</p>
</dd>
<dt class="hdlist1">
<strong>-v, --verbose</strong>
</dt>
<dd>
<p>
Print operational details to stderr.
A second <strong>-v</strong> option applies the verbose option to toolchain commands.
</p>
</dd>
<dt class="hdlist1">
<strong>--version</strong>
</dt>
<dd>
<p>
Print program version to stdout.
</p>
</dd>
<dt class="hdlist1">
<strong>--xsltproc-opts</strong>=<em>XSLTPROC_OPTS</em>
</dt>
<dd>
<p>
Additional <em>xsltproc(1)</em> options.
This option may be specified more than once.
</p>
</dd>
<dt class="hdlist1">
<strong>--xsl-file</strong>=<em>XSL_FILE</em>
</dt>
<dd>
<p>
Override the built-in XSL stylesheet with the custom XSL stylesheet
<em>XSL_FILE</em>.
</p>
</dd>
<dt class="hdlist1">
<strong>--fop</strong>
</dt>
<dd>
<p>
Use FOP to generate PDFs. The default behavior is to use
<em>dblatex(1)</em>. The <em>--fop</em> option is implicit if the <em>--fop-opts</em> option is
used.
</p>
</dd>
<dt class="hdlist1">
<strong>--fop-opts</strong>=<em>FOP_OPTS</em>
</dt>
<dd>
<p>
Additional <em>fop(1)</em> options. If this option is specified FOP is used
to generate PDFs.
This option may be specified more than once.
</p>
</dd>
<dt class="hdlist1">
<strong>--dblatex-opts</strong>=<em>DBLATEX_OPTS</em>
</dt>
<dd>
<p>
Additional <em>dblatex(1)</em> options.
This option may be specified more than once.
</p>
</dd>
<dt class="hdlist1">
<strong>--backend-opts</strong>=<em>BACKEND_OPTS</em>
</dt>
<dd>
<p>
Options for the backend plugin specified by the <em>--backend</em> option.
This option may be specified more than once.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Options can also be set in the AsciiDoc source file. If <em>SOURCE_FILE</em>
contains a comment line beginning with <strong>// a2x:</strong> then the remainder of
the line will be treated as <em>a2x</em> command-line options. For example:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>// a2x default options.
// a2x: -dbook --epubcheck
// Suppress revision history in dblatex outputs.
// a2x: --dblatex-opts "-P latex.output.revhistory=0"</code></pre>
</div></div>
<div class="ulist"><ul>
<li>
<p>
Options spanning multiple such comment lines will be concatenated.
</p>
</li>
<li>
<p>
Zero or more white space characters can appear between the leading
<strong>//</strong> and <strong>a2x:</strong>.
</p>
</li>
<li>
<p>
Command-line options take precedence over options set in the source
file.
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="X4">OUTPUT FILES</h2>
<div class="sectionbody">
<div class="paragraph"><p>Output files are written to the directory specified by the
<strong>--destination-dir</strong> option. If no <strong>--destination-dir</strong> option is set
output files are written to the <em>SOURCE_FILE</em> directory.</p></div>
<div class="paragraph"><p>Output files have the same name as the <em>SOURCE_FILE</em> but with an
appropriate file name extension: <code>.html</code> for <em>xhtml</em>; <code>.epub</code> for
<em>epub</em>; <code>.hhp</code> for <em>htmlhelp</em>; <code>.pdf</code> for <em>pdf</em>; <code>.text</code> for <em>text</em>,
<code>.xml</code> for <em>docbook</em>. By convention manpages have no <code>.man</code> extension
(man page section number only). Chunked HTML directory names have a
<code>.chunked</code> extension; chunked HTML Help directory names have a
<code>.htmlhelp</code> extension.</p></div>
<div class="paragraph"><p>Same named existing files are overwritten.</p></div>
<div class="paragraph"><p>In addition to generating HTML files the <em>xhtml</em>, <em>epub</em>, <em>chunked</em>
and <em>htmlhelp</em> formats ensure <a href="#X3">resource files</a> are copied to
their correct destination directory locations.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="X3">RESOURCES</h2>
<div class="sectionbody">
<div class="paragraph"><p>Resources are files (typically CSS and images) that are required by
HTML based outputs (<em>xhtml</em>, <em>epub</em>, <em>chunked</em>, <em>htmlhelp</em> formats).
<em>a2x</em> scans the generated HTML files and builds a list of required CSS
and image files. Additional resource files can be specified explicitly
using the <strong>--resource</strong> option.</p></div>
<div class="paragraph"><p><em>a2x</em> searches for resource files in the following locations in the
following order:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
The <em>SOURCE_FILE</em> directory.
</p>
</li>
<li>
<p>
Resource directories specified by the <strong>--resource</strong> option (searched
recursively).
</p>
</li>
<li>
<p>
Resource directories specified by the <strong>--resource-manifest</strong> option
(searched recursively in the order they appear in the manifest
file).
</p>
</li>
<li>
<p>
The stock <code>images</code> and <code>stylesheets</code> directories in the
<em><code>asciidoc(1)</code></em> configuration files directories (searched
recursively).
</p>
</li>
<li>
<p>
The destination directory.
</p>
</li>
</ol></div>
<div class="paragraph"><p>When a resource file is found it is copied to the correct relative
destination directory. Missing destination sub-directories are created
automatically.</p></div>
<div class="paragraph"><p>There are two distinct mechanisms for specifying additional resources:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
A resource directory which will be searched recursively for missing
resource files.
</p>
</li>
<li>
<p>
A resource file which will be copied to the output destination
directory.
</p>
</li>
</ol></div>
<div class="paragraph"><p>Resources are specified with <strong>--resource</strong> option values which can be
one of the following formats:</p></div>
<div class="literalblock">
<div class="content">
<pre><code><resource_dir>
<resource_file>[=<destination_file>]
.<ext>=<mimetype></code></pre>
</div></div>
<div class="paragraph"><p>Where:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code><resource_dir></code>
</dt>
<dd>
<p>
Specifies a directory (absolute or relative to the <em>SOURCE_FILE</em>)
which is searched recursively for missing resource files. To
eliminate ambiguity the <code><resource_dir></code> name should end with a
directory separator character.
</p>
</dd>
<dt class="hdlist1">
<code><resource_file></code>
</dt>
<dd>
<p>
Specifies a resource file (absolute or relative to the
<em>SOURCE_FILE</em>) which will be copied to <code><destination_file></code>. If
<code><destination_file></code> is not specified then it is the same as the
<code><resource_file></code>.
</p>
</dd>
<dt class="hdlist1">
<code><destination_file></code>
</dt>
<dd>
<p>
Specifies the destination of the copied source file. The
<code><destination_file></code> path is relative to the destination directory
(absolute paths are not allowed). The location of the destination
directory depends on the output <em>FORMAT</em> (see the <a href="#X4"><strong>OUTPUT FILES</strong></a> section for details):
</p>
<div class="dlist"><dl>
<dt class="hdlist1">
chunked, htmlhelp
</dt>
<dd>
<p>
The chunked output directory.
</p>
</dd>
<dt class="hdlist1">
epub
</dt>
<dd>
<p>
The archived <code>OEBPS</code> directory.
</p>
</dd>
<dt class="hdlist1">
xhtml
</dt>
<dd>
<p>
The output <strong>DESTINATION_DIR</strong>.
</p>
</dd>
</dl></div>
</dd>
<dt class="hdlist1">
<code>.<ext>=<mimetype></code>
</dt>
<dd>
<p>
When adding resources to EPUB files the mimetype is inferred from
the <code><destination file></code> extension, if the mimetype cannot be
guessed an error occurs. The <code>.<ext>=<mimetype></code> resource syntax can
be used to explicitly set mimetypes. <code><ext></code> is the file name
extension, <code><mimetype></code> is the corresponding MIME type.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Resource option examples:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>--resource ../images/
--resource doc/README.txt=README.txt
--resource ~/images/tiger.png=images/tiger.png
--resource .ttf=application/x-font-ttf</code></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<code>a2x -f pdf doc/source-highlight-filter.txt</code>
</dt>
<dd>
<p>
Generates <code>doc/source-highlight-filter.pdf</code> file.
</p>
</dd>
<dt class="hdlist1">
<code>a2x -f xhtml -D ../doc --icons -r ../images/ team.txt</code>
</dt>
<dd>
<p>
Creates HTML file <code>../doc/team.html</code>, uses admonition icons and
recursively searches the <code>../images/</code> directory for any missing
resources.
</p>
</dd>
<dt class="hdlist1">
<code>a2x -f manpage doc/asciidoc.1.txt</code>
</dt>
<dd>
<p>
Generate <code>doc/asciidoc.1</code> manpage.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="X1">REQUISITES</h2>
<div class="sectionbody">
<div class="paragraph"><p><em>a2x</em> uses the following programs:</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>Asciidoc</strong>:
<a href="https://asciidoc.org/">https://asciidoc.org/</a>
</p>
</li>
<li>
<p>
<strong>xsltproc</strong>: (all formats except text):
<a href="http://xmlsoft.org/XSLT/">http://xmlsoft.org/XSLT/</a>
</p>
</li>
<li>
<p>
<strong>DocBook XSL Stylesheets</strong> (all formats except text):
<a href="https://github.com/docbook/xslt10-stylesheets">https://github.com/docbook/xslt10-stylesheets</a>
</p>
</li>
<li>
<p>
<strong>dblatex</strong> (pdf, dvi, ps, tex formats):
<a href="http://dblatex.sourceforge.net/">http://dblatex.sourceforge.net/</a>
</p>
</li>
<li>
<p>
<strong>FOP</strong> (pdf format — alternative PDF file generator):
<a href="https://xmlgraphics.apache.org/fop/">https://xmlgraphics.apache.org/fop/</a>
</p>
</li>
<li>
<p>
<strong>w3m</strong> (text format):
<a href="http://w3m.sourceforge.net/index.en.html">http://w3m.sourceforge.net/index.en.html</a>
</p>
</li>
<li>
<p>
<strong>Lynx</strong> (text format — alternative text file generator):
<a href="https://invisible-island.net/lynx/">https://invisible-island.net/lynx/</a>
</p>
</li>
<li>
<p>
<strong>epubcheck</strong> (epub format — EPUB file validator):
<a href="https://github.com/w3c/epubcheck">https://github.com/w3c/epubcheck</a>
</p>
</li>
</ul></div>
<div class="paragraph"><p>See also the latest README file.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="X2">CONF FILES</h2>
<div class="sectionbody">
<div class="paragraph"><p>A configuration file contains executable Python code that overrides
the global configuration parameters in <code>a2x.py</code>. Optional configuration
files are loaded in the following order:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
<code>a2x.conf</code> from the directory containing the <em>a2x.py</em> executable.
</p>
</li>
<li>
<p>
<code>a2x.conf</code> from the AsciiDoc global configuration directory. Skip
this step if we are executing a locally installed (non system wide)
copy.
</p>
</li>
<li>
<p>
<code>a2x.conf</code> from the AsciiDoc <code>$HOME/.asciidoc</code> configuration
directory.
</p>
</li>
<li>
<p>
The <em>CONF_FILE</em> specified in the <em>--conf-file</em> option.
</p>
</li>
</ol></div>
<div class="paragraph"><p>Here are the default configuration file option values:</p></div>
<div class="listingblock">
<div class="content">
<pre><code># Optional environment variable dictionary passed to
# executing programs. If set to None the existing
# environment is used.
ENV = None
# External executables.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # pdf generation.
FOP = 'fop' # pdf generation (--fop option).
W3M = 'w3m' # primary text file generator.
LYNX = 'lynx' # alternate text file generator.
XMLLINT = 'xmllint' # Set to '' to disable.
EPUBCHECK = 'epubcheck' # Set to '' to disable.
# External executable default options.
ASCIIDOC_OPTS = ''
BACKEND_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
LYNX_OPTS = '-dump'
W3M_OPTS = '-dump -cols 70 -T text/html -no-graph'
XSLTPROC_OPTS = ''</code></pre>
</div></div>
<div class="paragraph"><p>Note, that it is possible to redefine <code>W3M</code> and <code>LYNX</code> to use different text-based
browsers, e.g. <em>links</em>: <a href="http://links.twibright.com/">http://links.twibright.com/</a> or
<em>elinks</em>: <a href="http://elinks.or.cz/">http://elinks.or.cz/</a>. <code>LYNX_OPTS</code> and <code>W3M_OPTS</code> can be used to pass
options to the selected browser. If these are defined they override the
respective defaults listed above (so don’t forget to include the <em>-dump</em> option
in your definition: this is mandatory at least with <em>w3m</em>, <em>lynx</em>, <em>links</em>, and
<em>elinks</em> in order to send the formatted text to stdout).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_bugs">BUGS</h2>
<div class="sectionbody">
<div class="paragraph"><p>See the AsciiDoc distribution BUGS file.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_author">AUTHOR</h2>
<div class="sectionbody">
<div class="paragraph"><p>a2x was originally written by Stuart Rackham. Many people have
contributed to it.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_resources">RESOURCES</h2>
<div class="sectionbody">
<div class="paragraph"><p>GitHub: <a href="https://github.com/asciidoc/asciidoc-py3/">https://github.com/asciidoc/asciidoc-py3/</a></p></div>
<div class="paragraph"><p>Main web site: <a href="https://asciidoc.org/">https://asciidoc.org/</a></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph"><p><code>asciidoc(1)</code></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_copying">COPYING</h2>
<div class="sectionbody">
<div class="paragraph"><p>Copyright (C) 2002-2013 Stuart Rackham.</p></div>
<div class="paragraph"><p>Copyright (C) 2013-2020 AsciiDoc Contributors.</p></div>
<div class="paragraph"><p>Free use of this software is granted under the terms of the MIT license.</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 9.0.5<br />
Last updated 2021-02-06 05:09:50 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
<a href="https://validator.w3.org/check?uri=referer">
<img style="border:0;width:88px;height:31px"
src="https://www.w3.org/Icons/valid-xhtml11-blue"
alt="Valid XHTML 1.1" height="31" width="88" />
</a>
<a href="https://jigsaw.w3.org/css-validator/">
<img style="border:0;width:88px;height:31px"
src="https://jigsaw.w3.org/css-validator/images/vcss-blue"
alt="Valid CSS!" />
</a>
</div>
</div>
</div>
</div>
</body>
</html>
|
