Package: asciidoc / 8.6.10-3

adding_testasciidoc_manpage.patch Patch series | download
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
Author: Joseph Herlant <herlantj@gmail.com>
Description: Adding manpage for testasciidoc to remove lintian warning:
binary-without-manpage usr/bin/testasciidoc
Forwared: https://github.com/asciidoc/asciidoc/pull/10
--- /dev/null
+++ b/doc/testasciidoc.1.txt
@@ -0,0 +1,120 @@
+TESTASCIIDOC(1)
+===============
+:doctype: manpage
+
+
+NAME
+----
+testasciidoc - Run AsciiDoc conformance tests specified in configuration file.
+
+
+SYNOPSIS
+--------
+*testasciidoc* ['OPTIONS'] 'COMMAND'
+
+
+DESCRIPTION
+-----------
+The testasciidoc command runs AsciiDoc conformance tests specified in
+configuration file.
+
+
+COMMANDS
+--------
+The testasciidoc toolset has three different commands:
+
+  testasciidoc list
+  testasciidoc run [NUMBER] [BACKEND] [OPTIONS]
+  testasciidoc update [NUMBER] [BACKEND] [OPTIONS]
+
+The commands perform as follows:
+
+*list*::
+  List available tests cases.
+
+*run*::
+  Execute tests (regenerate temporary test cases and compare them to the
+  reference files).
+
+*update*::
+  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.
+
+Where:
+
+*NUMBER*::
+  Is the index number of the test case from the `testasciidoc list` command.
+
+*BACKEND*::
+  Is the asciidoc backend to use.
+
+*OPTIONS*::
+  Are the options listed below.
+
+
+OPTIONS
+-------
+*-f, --conf-file*='CONF_FILE'::
+    Use configuration file CONF_FILE for more information about the
+    configuration file format refer to the tests documentation.
+
+*--force*::
+    Update all test data overwriting existing data
+
+
+EXAMPLES
+--------
+`testasciidoc list`::
+  Lists all the test actions available for running or updating.
+
+`testasciidoc run`::
+  Runs all the testing actions available.
+
+`testasciidoc run 1 html5 --conf-file=/etc/asciidoc/testasciidoc.conf`::
+  Run the test case 1 for the html5 asciidoc backend using the configuration file
+  /etc/asciidoc/testasciidoc.conf.
+
+`testasciidoc update 1 html5`::
+  Generate or update the reference files used for the tests cases 1st action of
+  the html5 asciidoc backend.
+
+
+EXIT STATUS
+-----------
+*0*::
+    Success
+
+*1*::
+    Failure (syntax or usage error; configuration error; document
+    processing failure; unexpected error).
+
+
+BUGS
+----
+See the AsciiDoc distribution BUGS file.
+
+
+AUTHOR
+------
+AsciiDoc was originally written by Stuart Rackham. Many people have
+contributed to it.
+
+
+RESOURCES
+---------
+SourceForge: <http://sourceforge.net/projects/asciidoc/>
+
+Main web site: <http://asciidoc.org/>
+
+
+SEE ALSO
+--------
+asciidoc(1), a2x(1)
+
+
+COPYING
+-------
+Copyright \(C) 2014 Joseph Herlant. Free use of this software is
+granted under the terms of the GNU General Public License (GPL).
+