blob: b106f8a5420d216f228dcdb4dc5f994cf9a199d3 (
plain)
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
|
<!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 9.0.4" />
<title>TESTASCIIDOC(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="testasciidoc.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>
TESTASCIIDOC(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>testasciidoc -
Run AsciiDoc conformance tests specified in configuration file.
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p><strong>testasciidoc</strong> [<em>OPTIONS</em>] <em>COMMAND</em></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>The testasciidoc command runs AsciiDoc conformance tests specified in
configuration file.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_commands">COMMANDS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The testasciidoc toolset has three different commands:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>testasciidoc list
testasciidoc run [-n, --number NUMBER] [-b, --backend BACKEND] [OPTIONS]
testasciidoc update [-n, --number NUMBER] [-b, --backend BACKEND] [OPTIONS]</code></pre>
</div></div>
<div class="paragraph"><p>The commands perform as follows:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>list</strong>
</dt>
<dd>
<p>
List available tests cases.
</p>
</dd>
<dt class="hdlist1">
<strong>run</strong>
</dt>
<dd>
<p>
Execute tests (regenerate temporary test cases and compare them to the
reference files).
</p>
</dd>
<dt class="hdlist1">
<strong>update</strong>
</dt>
<dd>
<p>
Regenerate and update test data reference files.
Needs to be launched at least once to have the reference files to compare to
during the tests.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Where:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>NUMBER</strong>
</dt>
<dd>
<p>
Is the index number of the test case from the <code>testasciidoc list</code> command.
</p>
</dd>
<dt class="hdlist1">
<strong>BACKEND</strong>
</dt>
<dd>
<p>
Is the asciidoc backend to use.
</p>
</dd>
<dt class="hdlist1">
<strong>OPTIONS</strong>
</dt>
<dd>
<p>
Are the options listed below.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>-f, --conf-file</strong>=<em>CONF_FILE</em>
</dt>
<dd>
<p>
Use configuration file CONF_FILE for more information about the
configuration file format refer to the tests documentation.
</p>
</dd>
<dt class="hdlist1">
<strong>--force</strong>
</dt>
<dd>
<p>
Update all test data overwriting existing data
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<code>testasciidoc list</code>
</dt>
<dd>
<p>
Lists all the test actions available for running or updating.
</p>
</dd>
<dt class="hdlist1">
<code>testasciidoc run</code>
</dt>
<dd>
<p>
Runs all the testing actions available.
</p>
</dd>
<dt class="hdlist1">
<code>testasciidoc run --number 1 --backend html5 --conf-file=/etc/asciidoc/testasciidoc.conf</code>
</dt>
<dd>
<p>
Run the test case 1 for the html5 asciidoc backend using the configuration file
/etc/asciidoc/testasciidoc.conf.
</p>
</dd>
<dt class="hdlist1">
<code>testasciidoc update --number 1 --backend html5</code>
</dt>
<dd>
<p>
Generate or update the reference files used for the tests cases 1st action of
the html5 asciidoc backend.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_exit_status">EXIT STATUS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>0</strong>
</dt>
<dd>
<p>
Success
</p>
</dd>
<dt class="hdlist1">
<strong>1</strong>
</dt>
<dd>
<p>
Failure (syntax or usage error; configuration error; document
processing failure; unexpected error).
</p>
</dd>
</dl></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>AsciiDoc 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>, <code>a2x(1)</code></p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 9.0.4<br />
Last updated 2020-12-14 07:20:15 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>
|
