Updated.

Author: sideshowbarker

README.md

@@ -1,33 +1,36 @@
 # How to use the vnu.jar validator
 
-The `vnu.jar` validator is a packaged standalone version of the
-[validator.nu][1] code. The [latest version][2] is available from the [validator
-area at github][3]. The following are instructions on how to use it to validate
-documents.
+The `vnu.jar` application is a portable standalone version of the
+[validator.nu][1] validator. The [latest version][2] is available from the
+[validator area at github][3]. The following are instructions on how to use it
+to validate documents.
 
    [1]: http://about.validator.nu/
    [2]: https://github.com/validator/validator.github.io/releases
    [3]: https://github.com/validator/validator.github.io/
 
+**Note:** In the instructions, replace _"~/vnu.jar"_ with the actual path to the
+`vnu.jar` file on your system.
+
 ## Command-line usage
 
 You can use the `vnu.jar` validator as an executable for command-line validation
 of HTML documents by invoking it like this:
 
-      java -jar vnu.jar [--html] [--entities] [--schema URL]
+      java -jar ~/vnu.jar [--help] [--html] [--entities] [--schema URL]
           [--format gnu|xml|json|text] [--verbose] [--version] FILES
 
 To validate one or more documents from the command line:
 
-      java -jar vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
+      java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
 
 To validate all HTML documents in a particular directory:
 
-      java -jar vnu.jar some-directory-name/
+      java -jar ~/vnu.jar some-directory-name/
 
 To validate a Web document:
 
-      java -jar vnu.jar http://example.com/foo
+      java -jar ~/vnu.jar http://example.com/foo
 
 ### Command-line options
 
@@ -41,7 +44,7 @@ executable provides the following options:
 
     default: [unset; the XML parser will attempt to load external entities]
 
-#### --format format
+#### --format _format_
 
     Specifies the output format for validation results.
 
@@ -61,7 +64,7 @@ executable provides the following options:
 
     default: [unset; *.xhtml documents are parsed by the XML parser]
 
-#### --schema URL
+#### --schema _URL_
 
     Specifies a URL for a known http://s.validator.nu/* schema to use for
     document validation.
@@ -90,7 +93,7 @@ the Web, in a Web browser, as an HTTP service—just as with
 To run the validator as an HTTP service, open a new terminal window and invoke
 `vnu.jar` like this:
 
-      java -cp vnu.jar nu.validator.servlet.Main 8888
+      java -cp ~/vnu.jar nu.validator.servlet.Main 8888
 
 Then open [http://localhost:8888][7] in a browser. (To have the validator listen
 on a different port, replace `8888` with the port number.)
@@ -110,24 +113,24 @@ locally-running instance of the HTTP service for validation. To validate
 documents in that way, do this:
 
   1. Open a new terminal window and start up the validator as an HTTP service,
-  as described in the Web-based usage section.
+  as described in the "Web-based usage" section.
 
   2. Open a second new terminal window and invoke `vnu.jar` like this:
 
-      java -cp vnu.jar nu.validator.client.HttpClient FILE.html...
+      java -cp ~/vnu.jar nu.validator.client.HttpClient FILE.html...
 
 ### HTTP client options
 
-When using the `vnu.jar` for sending documents to a locally-running instance of
-the validator HTTP service for validation, you can set Java system properties to
+When using `vnu.jar` for sending documents to a locally-running instance of the
+validator HTTP service for validation, you can set Java system properties to
 control configuration options for the validation behavior.
 
 For example, you can suppress warning-level validation messages and only show
 error-level ones by setting the value of the `nu.validator.client.level` system
 property to `error`, like this:
 
        java -Dnu.validator.client.level=error\
-           -cp vnu.jar nu.validator.client.HttpClient FILE.html...
+           -cp ~/vnu.jar nu.validator.client.HttpClient FILE.html...
 
 Most of the properties listed below map to the validator.nu common input
 parameters documented at
@@ -147,7 +150,7 @@ parameters documented at
 
     default: "8888"
 
-    example: java -Dnu.validator.client.port=8080 -jar vnu.jar FILE.html
+    example: java -Dnu.validator.client.port=8080 -jar ~/vnu.jar FILE.html
 
 #### nu.validator.client.level
 
@@ -159,7 +162,7 @@ parameters documented at
 
     possible values: "error"
 
-    example: java -Dnu.validator.client.level=error -jar vnu.jar FILE.html
+    example: java -Dnu.validator.client.level=error -jar ~/vnu.jar FILE.html
 
 #### nu.validator.client.parser
 

index.html

@@ -1,19 +1,23 @@
 <!doctype html><html><head><meta charset=utf-8>
-<title>How to use the validator - validator.github.io</title></head>
+<title>How to use the vnu.jar validator</title></head>
 <body>
   <h1>How to use the vnu.jar validator</h1>
 
-    <p>The <code>vnu.jar</code> validator is a packaged standalone
+    <p>The <code>vnu.jar</code> application is a portable standalone
     version of the
     <a href="http://about.validator.nu/">validator.nu</a>
-    code. The
+    validator. The
     <a href="https://github.com/validator/validator.github.io/releases"
       >latest version</a>
     is available from the
     <a href="https://github.com/validator/validator.github.io/"
       >validator area at github</a>.
     The following are instructions on how to use it to validate documents.
 
+<p class=note><b>Note:</b> In the instructions, replace
+<var>"~/vnu.jar"</var> with the actual path to the <code>vnu.jar</code>
+file on your system.
+
 <p class=links>
 Command-line: 
 <a href="#command-line-usage">usage</a> · 
@@ -32,26 +36,26 @@ <h2>Command-line usage</h2>
     command-line validation of HTML documents by invoking it like this:
 
 <pre>
-  java -jar vnu.jar [--html] [--entities] [--schema URL]
+  java -jar ~/vnu.jar [--help] [--html] [--entities] [--schema URL]
       [--format gnu|xml|json|text] [--verbose] [--version] FILES
 </pre>
 
     <p>To validate one or more documents from the command line:
 
 <pre>
-  java -jar vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
+  java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
 </pre>
 
     <p>To validate all HTML documents in a particular directory:
 
 <pre>
-  java -jar vnu.jar some-directory-name/
+  java -jar ~/vnu.jar some-directory-name/
 </pre>
 
     <p>To validate a Web document:
 
 <pre>
-  java -jar vnu.jar http://example.com/foo
+  java -jar ~/vnu.jar http://example.com/foo
 </pre>
 
     <h3 id="command-line-options">Command-line options</h3>
@@ -121,7 +125,7 @@ <h2>Web-based usage</h2>
     and invoke <code>vnu.jar</code> like this:
 
 <pre>
-  java -cp vnu.jar <span class=java-class>nu.validator.servlet.Main</span> <span class=arg>8888</span>
+  java -cp ~/vnu.jar <span class=java-class>nu.validator.servlet.Main</span> <span class=arg>8888</span>
 </pre>
 
     <p>Then open
@@ -145,22 +149,22 @@ <h2>HTTP client (for fast command-line validation)</h2>
 
       <li>Open a new terminal window and start up the validator as an HTTP
       service, as described in the
-      <a href="#web-based-usage">Web-based usage</a> section.
+      "<a href="#web-based-usage">Web-based usage</a>" section.
 
       <li>Open a second new terminal window and invoke <code>vnu.jar</code>
       like this:
 
 <pre>
-  java -cp vnu.jar <span class=java-class>nu.validator.client.HttpClient</span> FILE.html...
+  java -cp ~/vnu.jar <span class=java-class>nu.validator.client.HttpClient</span> FILE.html...
 </pre>
     </ol>
 
     <h3 id="http-client-options">HTTP client options</h3>
 
-    <p>When using the <code>vnu.jar</code> for sending documents to a
+    <p>When using <code>vnu.jar</code> for sending documents to a
     locally-running instance of the validator HTTP service for validation,
-    you can set Java system properties to control configuration options for
-    the validation behavior.
+    you can set Java system properties to control configuration options for the
+    validation behavior.
 
     <p>For example, you can suppress warning-level validation messages and only
     show error-level ones by setting the value of the
@@ -169,7 +173,7 @@ <h3 id="http-client-options">HTTP client options</h3>
 
 <pre>
    java <span class=java-property>-Dnu.validator.client.level=error</span>\
-       -cp vnu.jar <span class=java-class>nu.validator.client.HttpClient</span> FILE.html...
+       -cp ~/vnu.jar <span class=java-class>nu.validator.client.HttpClient</span> FILE.html...
 </pre>
 
     <p>Most of the properties listed below map to the validator.nu common input
@@ -184,17 +188,15 @@ <h4 id="nuvalidatorclienthost">nu.validator.client.host</h4>
 default: <span class=option-value>"127.0.0.1"</span>
 </pre>
 
-
 <h4 id="nuvalidatorclientport">nu.validator.client.port</h4>
 <pre>
 Specifies the hostname of the validator for the client to connect to.
 
 default: <span class=option-value>"8888"</span>
 
-example: java -Dnu.validator.client.port=8080 -jar vnu.jar FILE.html
+example: java -Dnu.validator.client.port=8080 -jar ~/vnu.jar FILE.html
 </pre>
 
-
 <h4 id="nuvalidatorclientlevel">nu.validator.client.level</h4>
 <pre>
 Specifies the severity level of validation messages to report; to
@@ -205,10 +207,9 @@ <h4 id="nuvalidatorclientlevel">nu.validator.client.level</h4>
 
 possible values: <span class=option-value>"error"</span>
 
-example: java -Dnu.validator.client.level=error -jar vnu.jar FILE.html
+example: java -Dnu.validator.client.level=error -jar ~/vnu.jar FILE.html
 </pre>
 
-
 <h4 id="nuvalidatorclientparser">nu.validator.client.parser</h4>
 <pre>
 Specifies which parser to use.
@@ -218,23 +219,20 @@ <h4 id="nuvalidatorclientparser">nu.validator.client.parser</h4>
 possible values: see <a href="http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#parser">http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#parser</a>
 </pre>
 
-
 <h4 id="nuvalidatorclientcharset">nu.validator.client.charset</h4>
 <pre>
 Specifies the encoding of the input document.
 
 default: [unset]
 </pre>
 
-
 <h4 id="nuvalidatorclientcontent-type">nu.validator.client.content-type</h4>
 <pre>
 Specifies the content-type of the input document.
 
 default: <span class=option-value>"text/html"</span>; or, for *.xhtml files, <span class=option-value>"application/xhtml+xml"</span>
 </pre>
 
-
 <h4 id="nuvalidatorclientout">nu.validator.client.out</h4>
 <pre>
 Specifies the output format for validation messages.
@@ -319,7 +317,7 @@ <h4 id="nuvalidatorclientasciiquotes">nu.validator.client.asciiquotes</h4>
   background-color: white;
   color: black;
 }
-.set {
+.set, .note {
   background-color: ivory;
   padding: 16px;
   padding-top: 4px;