|
1 | 1 | <!doctype html><html><head><meta charset=utf-8> |
2 | | -<title>The Nu Markup Checker (v.Nu)</title> |
3 | | -<link rel=stylesheet href=style.css></head> |
4 | | -<body> |
5 | | - <h1>The Nu Markup Checker (v.Nu)</h1> |
6 | | - |
7 | | - <p> |
8 | | - The Nu Markup Checker (v.Nu) is a name for the backend of |
9 | | - <a href="http://html5.validator.nu">html5.validator.nu</a>, |
10 | | - <a href="http://validator.w3.org/nu/">validator.w3.org/nu</a>, |
11 | | - and the HTML5 facet of the legacy |
12 | | - <a href="http://validator.w3.org">W3C Validator</a>. |
13 | | - |
14 | | - Its source code is available from |
15 | | - <a href="https://github.com/validator/">a set of github repositories</a>. |
16 | | - The checker is released as two separate packages: |
17 | | - <ul> |
18 | | - <li><code>vnu.jar</code> is a portable standalone version for |
19 | | - <a href="http://validator.github.io/#usage">batch-checking documents from the command line</a> |
20 | | - and from other scripts/apps, or for |
21 | | - <a href="http://validator.github.io/service.html#standalone">deploying the checker as a self-contained service</a> |
22 | | - <li><code>vnu.war</code> is for |
23 | | - <a href="http://validator.github.io/service.html#servlet">deploying the checker service through a servlet container such as Tomcat</a> |
24 | | - </ul> |
25 | | - |
26 | | - <p> |
27 | | - To use the Nu Markup Checker on your own, |
28 | | - <a href="https://github.com/validator/validator.github.io/releases/latest">get the latest release</a> |
29 | | - and see the <a href="#usage"><b>Usage</b> section</a> below— |
30 | | - or alternatively, consider automating your HTML checking with a frontend such as: |
31 | | -<ul> |
32 | | -<li> |
33 | | -<a href="https://github.com/jzaefferer/grunt-html">Grunt plugin for HTML validation</a> |
34 | | -<li> |
35 | | -<a href="https://github.com/svenkreiss/html5validator">HTML5 Validator Integration for Travis CI</a> |
36 | | -(auto-check documents pushed to a github repo) |
37 | | -<li> |
38 | | -<a href="https://github.com/cvrebert/lmvtfy/">LMVTFY: Let Me Validate That For You</a> |
39 | | -(auto-check HTML of JSFiddle/JSBin etc. links in github issue comments) |
40 | | -</ul> |
41 | | - |
42 | | -<p class=links> |
43 | | -<a href="#usage">Usage</a> · |
44 | | -<a href="#options">Options</a> |
45 | | - |
46 | | - <div class=set> |
47 | | - <section id=usage> |
48 | | - <h2>Usage</h2> |
49 | | - |
50 | | -<p>You can use the <code>vnu.jar</code> markup checker as an executable for |
51 | | -command-line checking of HTML documents by invoking it like this: |
52 | | -<pre> |
53 | | - java -jar ~/vnu.jar [--errors-only] [--no-stream] |
54 | | - [--format gnu|xml|json|text] [--help] [--html] |
55 | | - [--verbose] [--version] FILES |
56 | | -</pre> |
57 | | - |
58 | | -<p class=note><b>Note:</b> In these instructions, replace |
59 | | -<var>"~/vnu.jar"</var> with the actual path to the file on your system. |
60 | | - |
61 | | -<p>To check one or more HTML documents from the command line: |
62 | | -<pre> |
63 | | - java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html... |
64 | | -</pre> |
65 | | - |
66 | | -<div class=note> |
67 | | -<p><b>Note:</b> If you get a <code>StackOverflowError</code> |
68 | | -error when using the vnu.jar file, try adjusting the thread stack size by |
69 | | -providing the <code>-Xss</code> option to java:</p> |
70 | | - |
71 | | -<pre> |
72 | | - java <span class="option-value">-Xss512k</span> -jar ~/vnu.jar FILE.html... |
73 | | -</pre> |
74 | | - |
75 | | -</div> |
76 | | - |
77 | | -<p>To check all HTML documents in a particular directory: |
78 | | -<pre> |
79 | | - java -jar ~/vnu.jar some-directory-name/ |
80 | | -</pre> |
81 | | - |
82 | | -<p>To check a Web document: |
83 | | -<pre> |
84 | | - java -jar ~/vnu.jar <var>URL</var> |
85 | | - |
86 | | - example: java -jar ~/vnu.jar http://example.com/foo |
87 | | -</pre> |
88 | | - |
89 | | -<p>To check standard input: |
90 | | -<pre> |
91 | | - java -jar ~/vnu.jar - |
92 | | - |
93 | | - example: echo '<!doctype html><title>...' | java -jar ~/vnu.jar - |
94 | | -</pre> |
95 | | - |
96 | | -<h3 id="options">Options</h3> |
97 | | -<p>When used from the command line as described in this section, the |
98 | | -<code>vnu.jar</code> executable provides the following options: |
99 | | - |
100 | | -<h4 id="errors-only">--errors-only</h4> |
101 | | -<pre> |
102 | | -Specifies that only error-level messages and non-document-error messages |
103 | | -are reported (so that warnings and info messages are not reported). |
104 | | - |
105 | | -default: [unset; all message reported, including warnings & info messages] |
106 | | -</pre> |
107 | | - |
108 | | -<h4 id="format">--format <var>format</var></h4> |
109 | | -<pre> |
110 | | -Specifies the output format for reporting the results. |
111 | | - |
112 | | -default: <span class=option-value>"gnu"</span> |
113 | | - |
114 | | -possible values: <span class=option-value>"gnu"</span>, <span class=option-value>"xml"</span>, <span class=option-value>"json"</span>, <span class=option-value>"text"</span> |
115 | | - |
116 | | -see also: <a href="https://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out">wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out</a> |
117 | | -</pre> |
118 | | - |
119 | | -<h4 id="help">--help</h4> |
120 | | -<pre> |
121 | | -Shows detailed usage information. |
122 | | -</pre> |
123 | | - |
124 | | -<h4 id="html">--html</h4> |
125 | | -<pre> |
126 | | -Forces all documents to be parsed by the HTML parser, as text/html |
127 | | -(otherwise, *.xhtml documents are parsed using an XML parser). |
128 | | - |
129 | | -default: [unset; *.xhtml documents are parsed using an XML parser] |
130 | | -</pre> |
131 | | - |
132 | | -<h4 id="no-stream">--no-stream</h4> |
133 | | -<pre> |
134 | | -Forces all documents to be be parsed in buffered mode instead of streaming |
135 | | -mode (causes some parse errors to be treated as non-fatal document errors |
136 | | -instead of as fatal document errors). |
137 | | - |
138 | | -default: [unset; non-streamable parse errors cause fatal document errors] |
139 | | -</pre> |
140 | | - |
141 | | -<h4 id="verbose">--verbose</h4> |
142 | | -<pre> |
143 | | -Specifies "verbose" output. (Currently this just means that the names of |
144 | | -files being checked are written to stdout.) |
145 | | - |
146 | | -default: [unset; output is not verbose] |
147 | | -</pre> |
148 | | - |
149 | | -<h4 id="version">--version</h4> |
150 | | -<pre> |
151 | | -Shows the <code>vnu.jar</code> version number. |
152 | | -</pre> |
153 | | -</section> |
154 | | -</div> |
155 | | - |
156 | | -<p>To provide browser-based checking of documents over the Web, see |
157 | | -<a href="http://validator.github.io/service.html">Web-based checking with vnu.war or vnu.jar</a>. |
| 2 | +<meta http-equiv="refresh" content="0; url=http://validator.github.io/validator/"> |
0 commit comments