Commits

Michael[tm] Smith committed 9ec68e6

updated

Comments (0)

Files changed (1)

 ## Using
 
-There are two ways you can use the code here to validate documents:
-
-A. Use the pre-built vnu.jar and vnu-fast-client.jar files
-
-  or
-
-B. Download, build, and run the validator from the sources
+There are two ways you can use the code here to validate documents: (A) Use
+the pre-built vnu.jar and vnu-fast-client.jar files, or (B) download,
+build, and run the validator from the sources. 
 
 This section explains how to use the pre-built jar files. For information
 on how to download, build, and run the validator from the sources, see the
 
 You can validate a single document by doing this:
 
-    `java -jar vnu.jar FILE.html`
+    java -jar vnu.jar FILE.html
 
 You can batch-validate multiple files at once by doing this:
 
-    `java -jar vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...`
+    java -jar vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
 
 Or by doing something like this:
 
-    `java -jar vnu.jar $(find . -name "*.html")`
+    java -jar vnu.jar $(find . -name "*.html")
 
 ### Faster validation
 
 
 To do that, you first need to start the validator by doing this:
 
-    `java -cp vnu.jar nu.validator.servlet.Main 8888`
+    java -cp vnu.jar nu.validator.servlet.Main 8888
 
 (To have the validator listen on a different port, replace `8888` with the
 port number.)
 In a separate console window, you can validate a single document by doing
 this:
 
-    `java -jar vnu-fast-client.jar FILE.html`
+    java -jar vnu-fast-client.jar FILE.html
 
 You can batch-validate multiple files at once by doing this:
 
-    `java -jar vnu-fast-client.jar FILE.html FILE2.html FILE3.HTML...`
+    java -jar vnu-fast-client.jar FILE.html FILE2.html FILE3.HTML...
 
 Or by doing something like this:
 
-    `java -jar vnu-fast-client.jar $(find . -name "*.html")`
+    java -jar vnu-fast-client.jar $(find . -name "*.html")
 
 ### Configuration
 
 
     Specifies the hostname of the validator for the client to connect to.
 
-    default: `127.0.0.1`
+    default: 127.0.0.1
 
 #### nu.validator.client.port
 
     Specifies the hostname of the validator for the client to connect to.
 
-    default: `8888`
+    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
 
     Specifies the severity level of validation messages to report; to
-    suppress warning-level messages, set this to `error`.
+    suppress warning-level messages, set this to error.
 
     default: [unset]
 
-    possible values: `error`
+    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
 
     Specifies which parser to use.
 
-    default: `html` or (for `*.xhtml` files) `xml`
+    default: html or (for *.xhtml files) xml
 
     possible values: see
 [http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#parser][2]
 
    [2][http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#parser]
 
-    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.charset
 
 
     Specifies the content-type of the input document.
 
-    default: `text/html` or (for `*.xhtml` files) `application/xhtml+xml`
+    default: text/html or (for *.xhtml files) application/xhtml+xml
 
 ### nu.validator.client.out
 
     Specifies the output format for validation messages.
 
-    default: `gnu`
+    default: gnu
 
     possible values: see
 [http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters#out][3]
     Specifies whether ASCII quotation marks are substituted for Unicode
     smart quoation marks in validation messages.
 
-    default: `yes`
+    default: yes
 
-    possible values: `yes` or `no`
+    possible values: yes or no
 
 ## How to download, build, and run the validator from the sources
 
-  1. First, set the JAVA_HOME environment variable properly.
+1. First, set the JAVA_HOME environment variable properly.
 
-     On Ubuntu:
+   On Ubuntu:
 
-      `export JAVA_HOME=/usr/lib/jvm/java-6-openjdk`
+   `export JAVA_HOME=/usr/lib/jvm/java-6-openjdk`
 
-     On Mac OS X:
+   On Mac OS X:
 
-      `export JAVA_HTML=/Library/Java/Home`
+    `export JAVA_HTML=/Library/Java/Home`
 
-  2. Create a validator workspace.
+2. Create a validator workspace.
 
-      `mkdir checker`
+    mkdir checker
+    cd checker
+    hg clone https://bitbucket.org/validator/build build
 
-      `cd checker`
+   The above steps create a `checker` directory in which the build
+   script will create other subdirectories, and downloads the `build.py`
+   script itself into a `build` subdirectory in your `checker`
+   directory.
 
-      `hg clone https://bitbucket.org/validator/build build`
+3. Run the build script.
 
-      The above steps create a `checker` directory in which the build
-      script will create other subdirectories, and downloads the `build.py`
-      script itself into a `build` subdirectory in your `checker`
-      directory.
+    `python build/build.py all`
 
-  3. Run the build script.
-
-      `python build/build.py all`
-
-      `python build/build.py all`
+    `python build/build.py all`
 
 Yes, the last line is there twice intentionally. Running the script twice tends
 to fix a `ClassCastException` on the first run.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.