Skip to content

Commit 64b1f4e

Browse files
Updated.
1 parent 0918192 commit 64b1f4e

File tree

2 files changed

+39
-13
lines changed

2 files changed

+39
-13
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ of HTML documents by invoking it like this:
1919
java -jar ~/vnu.jar [--help] [--html] [--entities] [--schema URL]
2020
[--format gnu|xml|json|text] [--no-stream] [--verbose] [--version] FILES
2121

22-
To validate one or more documents from the command line:
22+
To validate one or more HTML documents from the command line:
2323

2424
java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
2525

@@ -46,7 +46,7 @@ executable provides the following options:
4646

4747
#### --entities
4848

49-
Specifies that the XML parser must not load remote/external entities (such
49+
Specifies that the XML parser should not load remote/external entities (such
5050
as DTDs) from the Internet.
5151

5252
default: [unset; the XML parser will attempt to load external entities]
@@ -64,13 +64,25 @@ executable provides the following options:
6464

6565
[2]: http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out
6666

67+
#### --help
68+
69+
Shows detailed usage information.
70+
6771
#### --html
6872

69-
Specifies that all documents must be parsed by the HTML parser as text/html
70-
(otherwise, *.xhtml documents are parsed by the XML parser).
73+
Specifies that all documents should be parsed by the HTML parser as
74+
text/html (otherwise, *.xhtml documents are parsed by the XML parser).
7175

7276
default: [unset; *.xhtml documents are parsed by the XML parser]
7377

78+
#### --no-stream
79+
80+
Specifies that all documents parsed by the HTML parser will be parsed in
81+
buffered mode instead of streaming mode (causes some parse errors to be
82+
treated as non-fatal document errors instead of as fatal document errors).
83+
84+
default: [unset; non-streamable parse errors cause fatal document errors]
85+
7486
#### --schema _URL_
7587

7688
Specifies a URL for a known http://s.validator.nu/* schema to use for
@@ -80,14 +92,14 @@ executable provides the following options:
8092

8193
#### --verbose
8294

83-
Specifies that the validator output should be "verbose". Currently this just
84-
means that the names of files being validated are written to stdout.
95+
Specifies that the validator output should be "verbose". (Currently this
96+
just means that the names of files being validated are written to stdout.)
8597

8698
default: [unset; output is not verbose]
8799

88100
#### --version
89101

90-
Shows validator version number.
102+
Shows the vnu.jar version number.
91103

92104
For details on using the `vnu.jar` validator to provide validation of HTML
93105
documents over the Web (in a Web browser, as an HTTP service), see [Using

index.html

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ <h2>Usage</h2>
2929
[--format gnu|xml|json|text] [--no-stream] [--verbose] [--version] FILES
3030
</pre>
3131

32-
<p>To validate one or more documents from the command line:
32+
<p>To validate one or more HTML documents from the command line:
3333
<pre>
3434
java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
3535
</pre>
@@ -59,7 +59,7 @@ <h3 id="options">Options</h3>
5959

6060
<h4 id="entities">--entities</h4>
6161
<pre>
62-
Specifies that the XML parser must not load remote/external entities (such
62+
Specifies that the XML parser should not load remote/external entities (such
6363
as DTDs) from the Internet.
6464

6565
default: [unset; the XML parser will attempt to load external entities]
@@ -76,14 +76,28 @@ <h4 id="format">--format <var>format</var></h4>
7676
see also: <a href="http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out">http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out</a>
7777
</pre>
7878

79+
<h4 id="help">--help</h4>
80+
<pre>
81+
Shows detailed usage information.
82+
</pre>
83+
7984
<h4 id="html">--html</h4>
8085
<pre>
81-
Specifies that all documents must be parsed by the HTML parser as text/html
86+
Specifies that all documents should be parsed by the HTML parser as text/html
8287
(otherwise, *.xhtml documents are parsed by the XML parser).
8388

8489
default: [unset; *.xhtml documents are parsed by the XML parser]
8590
</pre>
8691

92+
<h4 id="no-stream">--no-stream</h4>
93+
<pre>
94+
Specifies that all documents parsed by the HTML parser will be parsed in
95+
buffered mode instead of streaming mode (causes some parse errors to be
96+
treated as non-fatal document errors instead of as fatal document errors).
97+
98+
default: [unset; non-streamable parse errors cause fatal document errors]
99+
</pre>
100+
87101
<h4 id="schema-url">--schema <var>URL</var></h4>
88102
<pre>
89103
Specifies a URL for a known http://s.validator.nu/* schema to use for
@@ -94,15 +108,15 @@ <h4 id="schema-url">--schema <var>URL</var></h4>
94108

95109
<h4 id="verbose">--verbose</h4>
96110
<pre>
97-
Specifies that the validator output should be "verbose". Currently this
98-
just means that the names of files being validated are written to stdout.
111+
Specifies that the validator output should be "verbose". (Currently this
112+
just means that the names of files being validated are written to stdout.)
99113

100114
default: [unset; output is not verbose]
101115
</pre>
102116

103117
<h4 id="version">--version</h4>
104118
<pre>
105-
Shows validator version number.
119+
Shows the <code>vnu.jar</code> version number.
106120
</pre>
107121
</section>
108122
</div>

0 commit comments

Comments
 (0)