Skip to content

Commit 1a01837

Browse files
Drop some options from the docs.
1 parent 4ea7aaa commit 1a01837

2 files changed

Lines changed: 33 additions & 63 deletions

File tree

README.md

Lines changed: 17 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -21,25 +21,25 @@ grunt-html --save-dev`.
2121
You can use the `vnu.jar` markup checker as an executable for command-line
2222
checking of HTML documents by invoking it like this:
2323

24-
java -jar ~/vnu.jar [--entities] [--errors-only] [--no-stream]
25-
[--format gnu|xml|json|text] [--help] [--html] [--schema URL]
26-
[--verbose] [--version] FILES
24+
java -jar ~/vnu.jar [--errors-only] [--no-stream]
25+
[--format gnu|xml|json|text] [--help] [--html] [--verbose]
26+
[--version] FILES
2727

28-
To validate one or more HTML documents from the command line:
28+
To check one or more HTML documents from the command line:
2929

3030
java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
3131

32-
To validate all HTML documents in a particular directory:
32+
To check all HTML documents in a particular directory:
3333

3434
java -jar ~/vnu.jar some-directory-name/
3535

36-
To validate a Web document:
36+
To check a Web document:
3737

3838
java -jar ~/vnu.jar _URL_
3939

4040
example: java -jar ~/vnu.jar http://example.com/foo
4141

42-
To validate from standard input:
42+
To check standard input:
4343

4444
java -jar ~/vnu.jar -
4545

@@ -50,19 +50,12 @@ To validate from standard input:
5050
When used from the command line as described in this section, the `vnu.jar`
5151
executable provides the following options:
5252

53-
#### --entities
54-
55-
Specifies that the XML parser should not load remote/external entities (such
56-
as DTDs) from the Internet.
57-
58-
default: [unset; the XML parser will attempt to load external entities]
59-
6053
#### --errors-only
6154

6255
Specifies that only error-level messages and non-document-error messages are
63-
reported.
56+
reported (so that warnings and info messages are not reported).
6457

65-
default: [unset; all message reported, including info- and warning-level]
58+
default: [unset; all message reported, including warnings & info messages]
6659

6760
#### --format _format_
6861

@@ -83,30 +76,23 @@ executable provides the following options:
8376

8477
#### --html
8578

86-
Specifies that all documents should be parsed by the HTML parser as
87-
text/html (otherwise, *.xhtml documents are parsed by the XML parser).
79+
Forces all documents to be parsed by the HTML parser, as text/html
80+
(otherwise, *.xhtml documents are parsed using an XML parser).
8881

89-
default: [unset; *.xhtml documents are parsed by the XML parser]
82+
default: [unset; *.xhtml documents are parsed using an XML parser]
9083

9184
#### --no-stream
9285

93-
Specifies that all documents parsed by the HTML parser will be parsed in
94-
buffered mode instead of streaming mode (causes some parse errors to be
95-
treated as non-fatal document errors instead of as fatal document errors).
86+
Forces all documents to be be parsed in buffered mode instead of streaming
87+
mode (causes some parse errors to be treated as non-fatal document errors
88+
instead of as fatal document errors).
9689

9790
default: [unset; non-streamable parse errors cause fatal document errors]
9891

99-
#### --schema _URL_
100-
101-
Specifies a URL for a known http://s.validator.nu/* schema to use for
102-
document checking.
103-
104-
default: http://s.validator.nu/html5-all.rnc
105-
10692
#### --verbose
10793

108-
Specifies that the output should be "verbose". (Currently this just means
109-
that the names of files being validated are written to stdout.)
94+
Specifies "verbose" output. (Currently this just means that the names of
95+
files being checked are written to stdout.)
11096

11197
default: [unset; output is not verbose]
11298

index.html

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -31,29 +31,29 @@ <h2>Usage</h2>
3131
<p>You can use the <code>vnu.jar</code> markup checker as an executable for
3232
command-line checking of HTML documents by invoking it like this:
3333
<pre>
34-
java -jar ~/vnu.jar [--entities] [--errors-only] [--no-stream]
34+
java -jar ~/vnu.jar [--errors-only] [--no-stream]
3535
[--format gnu|xml|json|text] [--help] [--html]
36-
[--schema URL] [--verbose] [--version] FILES
36+
[--verbose] [--version] FILES
3737
</pre>
3838

39-
<p>To validate one or more HTML documents from the command line:
39+
<p>To check one or more HTML documents from the command line:
4040
<pre>
4141
java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
4242
</pre>
4343

44-
<p>To validate all HTML documents in a particular directory:
44+
<p>To check all HTML documents in a particular directory:
4545
<pre>
4646
java -jar ~/vnu.jar some-directory-name/
4747
</pre>
4848

49-
<p>To validate a Web document:
49+
<p>To check a Web document:
5050
<pre>
5151
java -jar ~/vnu.jar <var>URL</var>
5252

5353
example: java -jar ~/vnu.jar http://example.com/foo
5454
</pre>
5555

56-
<p>To validate from standard input:
56+
<p>To check standard input:
5757
<pre>
5858
java -jar ~/vnu.jar -
5959

@@ -64,20 +64,12 @@ <h3 id="options">Options</h3>
6464
<p>When used from the command line as described in this section, the
6565
<code>vnu.jar</code> executable provides the following options:
6666

67-
<h4 id="entities">--entities</h4>
68-
<pre>
69-
Specifies that the XML parser should not load remote/external entities (such
70-
as DTDs) from the Internet.
71-
72-
default: [unset; the XML parser will attempt to load external entities]
73-
</pre>
74-
7567
<h4 id="errors-only">--errors-only</h4>
7668
<pre>
7769
Specifies that only error-level messages and non-document-error messages
78-
are reported.
70+
are reported (so that warnings and info messages are not reported).
7971

80-
default: [unset; all message reported, including info- and warning-level]
72+
default: [unset; all message reported, including warnings & info messages]
8173
</pre>
8274

8375
<h4 id="format">--format <var>format</var></h4>
@@ -98,33 +90,25 @@ <h4 id="help">--help</h4>
9890

9991
<h4 id="html">--html</h4>
10092
<pre>
101-
Specifies that all documents should be parsed by the HTML parser as text/html
102-
(otherwise, *.xhtml documents are parsed by the XML parser).
93+
Forces all documents to be parsed by the HTML parser, as text/html
94+
(otherwise, *.xhtml documents are parsed using an XML parser).
10395

104-
default: [unset; *.xhtml documents are parsed by the XML parser]
96+
default: [unset; *.xhtml documents are parsed using an XML parser]
10597
</pre>
10698

10799
<h4 id="no-stream">--no-stream</h4>
108100
<pre>
109-
Specifies that all documents parsed by the HTML parser will be parsed in
110-
buffered mode instead of streaming mode (causes some parse errors to be
111-
treated as non-fatal document errors instead of as fatal document errors).
101+
Forces all documents to be be parsed in buffered mode instead of streaming
102+
mode (causes some parse errors to be treated as non-fatal document errors
103+
instead of as fatal document errors).
112104

113105
default: [unset; non-streamable parse errors cause fatal document errors]
114106
</pre>
115107

116-
<h4 id="schema-url">--schema <var>URL</var></h4>
117-
<pre>
118-
Specifies a URL for a known http://s.validator.nu/* schema to use for
119-
document checking.
120-
121-
default: <span class=option-value>http://s.validator.nu/html5-all.rnc</span>
122-
</pre>
123-
124108
<h4 id="verbose">--verbose</h4>
125109
<pre>
126-
Specifies that the output should be "verbose". (Currently this just means
127-
that the names of files being validated are written to stdout.)
110+
Specifies "verbose" output. (Currently this just means that the names of
111+
files being checked are written to stdout.)
128112

129113
default: [unset; output is not verbose]
130114
</pre>

0 commit comments

Comments
 (0)