Add note on using -Xss to avoid StackOverflowError

Author: sideshowbarker

README.md

@@ -31,6 +31,11 @@ To check one or more HTML documents from the command line:
 
       java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
 
+**Note:** If you get a `StackOverflowError` error when using the vnu.jar file,
+try adjusting the thread stack size by providing the `-Xss` option to java:
+
+      java -Xss512k -jar ~/vnu.jar FILE.html...
+
 To check all HTML documents in a particular directory:
 
       java -jar ~/vnu.jar some-directory-name/

index.html

@@ -43,6 +43,17 @@ <h2>Usage</h2>
   java -jar ~/vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...
 </pre>
 
+<div class=note>
+<p><b>Note:</b> If you get a <code>StackOverflowError</code>
+error when using the vnu.jar file, try adjusting the thread stack size by
+providing the <code>-Xss</code> option to java:</p>
+
+<pre>
+  java <span class="option-value">-Xss512k</span> -jar ~/vnu.jar FILE.html...
+</pre>
+
+</div>
+
 <p>To check all HTML documents in a particular directory:
 <pre>
   java -jar ~/vnu.jar some-directory-name/
@@ -199,6 +210,12 @@ <h4 id="version">--version</h4>
   margin-right: 2px;
   border-radius: 6px;
 }
+.note {
+  background-color: rgb(241, 255, 240);
+}
+.note p {
+  margin-top: 8px;
+}
 code {
   background-color: #F8F8F8;
   border: 1px solid #ccc;

service.html

@@ -49,6 +49,17 @@ <h2>Web-based usage</h2>
     that allows you to enter the URL of an HTML document and have the
     results for that document displayed in the browser.
 
+<div class=note>
+<p><b>Note:</b> If you get a <code>StackOverflowError</code>
+error when using the vnu.jar file, try adjusting the thread stack size by
+providing the <code>-Xss</code> option to java:</p>
+
+<pre>
+  java <span class="option-value">-Xss512k</span> -cp ~/vnu.jar nu.validator.servlet.Main 8888
+</pre>
+
+</div>
+
   <section id=http-client>
   <h2>HTTP client (for fast command-line checking)</h2>
 
@@ -239,6 +250,12 @@ <h4 id="nuvalidatorclientasciiquotes">nu.validator.client.asciiquotes</h4>
   margin-right: 2px;
   border-radius: 6px;
 }
+.note {
+  background-color: rgb(241, 255, 240);
+}
+.note p {
+  margin-top: 8px;
+}
 code {
   background-color: #F8F8F8;
   border: 1px solid #ccc;