Hi,
Just did a sweep over the latest 3.3 docs, particularly the user guide, and
picked up a few typos, apostrophe misuse and other stuff. Evidently tcsh users
don't read user guides, because the tcsh-specific commands were all wrong.
Patch attached..
--Jeff
PS: by comparison with 3.2, the docs have been *greatly* improved. Someone has
been very busy :)
Index: src/doc/mod_jk-howto.html
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat/src/doc/mod_jk-howto.html,v
retrieving revision 1.14
diff -u -r1.14 mod_jk-howto.html
--- src/doc/mod_jk-howto.html 2001/09/27 10:18:01 1.14
+++ src/doc/mod_jk-howto.html 2001/10/21 13:27:35
@@ -601,7 +601,7 @@
specified, defaults to "ajp13" if an Ajp13Interceptor
is in use, otherwise it defaults to "ajp12".</li>
<li><b>forwardAll</b> - If true, forward all requests to Tomcat.
- This helps insure that all the behavior configured in the web.xml
+ This helps ensure that all the behavior configured in the web.xml
file functions correctly. If false, let Apache serve static resources.
The default is true. Warning: When false, some configuration in
the web.xml may not be duplicated in Apache.
@@ -637,7 +637,7 @@
</blockquote>
differs from the file generated by Tomcat 3.2.x. In Tomcat 3.3, the default
is to forward all requests to Tomcat for Tomcat's contexts (i.e.
-forwardAll="true"), excluding the root context. This helps insure
+forwardAll="true"), excluding the root context. This helps ensure
that behavior configured in web.xml files will function properly.
The configuration that best matches Tomcat 3.2.x behavior is:
<blockquote>
Index: src/doc/readme
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat/src/doc/readme,v
retrieving revision 1.21
diff -u -r1.21 readme
--- src/doc/readme 2001/10/09 17:49:14 1.21
+++ src/doc/readme 2001/10/21 13:27:38
@@ -91,7 +91,7 @@
6. The default auto-generated configuration files configure the external
web server to send all requests for a context to Tomcat. That is the
- best way to insure that behavior specified in the web application's
+ best way to ensure that behavior specified in the web application's
web.xml functions properly. Also, by default, the configuration file
doesn't try to send any requests for the root context to Tomcat. The
external web server continues to serve its root context as they would
Index: src/doc/serverxml.html
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat/src/doc/serverxml.html,v
retrieving revision 1.8
diff -u -r1.8 serverxml.html
--- src/doc/serverxml.html 2001/10/19 03:16:13 1.8
+++ src/doc/serverxml.html 2001/10/21 13:27:46
@@ -32,7 +32,7 @@
number of settable properties and implements one or more 'hooks', providing a
piece of functionality.</p>
-<p>The modules can be configured and assembled in sevaral ways, but the
+<p>The modules can be configured and assembled in several ways, but the
default and most flexible mechanism uses XML files. Each module is described
by an XML element, with attributes used to set module properties. The main
configuration file is located in <code>TOMCAT_HOME/conf/server.xml</code>, used to
@@ -69,8 +69,8 @@
<h2>Configuration Elements</h2>
-<p>Server.xml is an XML document. Most elements corespond to tomcat modules,
-with java setters beeing automatically associated with element attributes. The
+<p>Server.xml is an XML document. Most elements correspond to tomcat modules,
+with java setters being automatically associated with element attributes. The
javadoc will contain most details, in this document we focus on the common
and supported behaviors. </p>
@@ -105,8 +105,8 @@
<dl>
<dt><<i>module_name</i>></dt>
<dd>Adds a module to the configuration. Module names are defined in
- module.xml, where each tag is associated with a class name that
- implements the module. Each element attribute coresponds to a setter
+ modules.xml, where each tag is associated with a class name that
+ implements the module. Each element attribute corresponds to a setter
method in the implementing class.</dd>
<dt><Context></dt>
<dd>Defines a web application. This is a legacy method of specifying a
@@ -654,7 +654,7 @@
</tr>
<tr valign="top">
<td>forwardAll</td>
- <td>If <code>true</code>, forward all requests to Tomcat. This helps insure that
all the
+ <td>If <code>true</code>, forward all requests to Tomcat. This helps ensure that
+all the
behavior configured in the web.xml file functions correctly. If
<code>false</code>,
let Apache serve static resources. Warning: When <code>false</code>, some
configuration
in the web.xml may not be duplicated in Apache. Review the mod_jk
@@ -996,7 +996,7 @@
<h4>Description</h4>
-<p>Handles incomming HTTP, or optionally HTTPS, requests.</p>
+<p>Handles incoming HTTP, or optionally HTTPS, requests.</p>
<h4>Attributes</h4>
@@ -1182,7 +1182,7 @@
</tr>
<tr valign="top">
<td>forwardAll</td>
- <td>If <code>true</code>, forward all requests to Tomcat. This helps insure that
all the
+ <td>If <code>true</code>, forward all requests to Tomcat. This helps ensure that
+all the
behavior configured in the web.xml file functions correctly. If
<code>false</code>,
let IIS serve static resources. Warning: When <code>false</code>, some
configuration
in the web.xml may not be duplicated in IIS. Review the configuration
@@ -1327,7 +1327,7 @@
<h4>Description</h4>
-<p>Insures that the proper context classloader is in effect during servlet
+<p>Ensures that the proper context classloader is in effect during servlet
execution.</p>
<h4>Attributes</h4>
@@ -1449,7 +1449,7 @@
</tr>
<tr valign="top">
<td>forwardAll</td>
- <td>If <code>true</code>, forward all requests to Tomcat. This helps insure that
all the
+ <td>If <code>true</code>, forward all requests to Tomcat. This helps ensure that
+all the
behavior configured in the web.xml file functions correctly. If
<code>false</code>,
let Apache serve static resources. Warning: When <code>false</code>, some
configuration
in the web.xml may not be duplicated in Apache. Review the tomcat-apache.conf
@@ -1902,7 +1902,7 @@
</tr>
<tr valign="top">
<td>forwardAll</td>
- <td>If <code>true</code>, forward all requests to Tomcat. This helps insure that
all the
+ <td>If <code>true</code>, forward all requests to Tomcat. This helps ensure that
+all the
behavior configured in the web.xml file functions correctly. If
<code>false</code>,
let Netscape serve static resources. Warning: When <code>false</code>, some
configuration
in the web.xml may not be duplicated in Netscape. Review the configuration
@@ -2122,7 +2122,7 @@
<h4>Description</h4>
-<p>Creates new session id's when needed for a request. If the
+<p>Creates new session IDs when needed for a request. If the
<code>randomFile</code> is not available, the class specified by
<code>randomClass</code> will be used. In this case, initialization of
class occurs on the first request requiring a session.</p>
Index: src/doc/tomcat-iis-howto.html
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat/src/doc/tomcat-iis-howto.html,v
retrieving revision 1.4
diff -u -r1.4 tomcat-iis-howto.html
--- src/doc/tomcat-iis-howto.html 2001/10/20 20:58:59 1.4
+++ src/doc/tomcat-iis-howto.html 2001/10/21 13:27:49
@@ -338,7 +338,7 @@
Foundation\Jakarta Isapi Redirector\1.0" key. Case isn't important,
but an incorrect letter will prevent the isapi_redirect.dll from finding
its registry settings.</li>
- <li>Check the <tt>log_file</tt> setting for typos, name and data. Also insure
+ <li>Check the <tt>log_file</tt> setting for typos, name and data. Also ensure
the directory in which the log file will appear already exists.</li>
</ol>
If the above are set correctly, the ISAPI redirector should be able to create
@@ -414,7 +414,7 @@
but an incorrect letter will prevent the isapi_redirect.dll from finding
its registry settings.</li>
<li>Check the <tt>log_file</tt> setting for typos, name and data. Also
- insure the directory in which the log file will appear already exists.</li>
+ ensure the directory in which the log file will appear already exists.</li>
</ol>
If the above are set correctly, the ISAPI redirector should be able to create
the log file.</li>
Index: src/doc/tomcat-security.html
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat/src/doc/tomcat-security.html,v
retrieving revision 1.3
diff -u -r1.3 tomcat-security.html
--- src/doc/tomcat-security.html 2000/08/28 19:05:27 1.3
+++ src/doc/tomcat-security.html 2001/10/21 13:27:50
@@ -47,7 +47,7 @@
running in your browser, use of a SecurityManager while running Tomcat
can protect your server from trojan servlets, JSP's, JSP beans, and tag
libraries. Or even inadvertent mistakes.
-<p>Imagine if someone who is authorized to publish JSP's on your site invadvertently
+<p>Imagine if someone who is authorized to publish JSP's on your site inadvertently
included the following in their JSP:
<blockquote>
<pre><% System.exit(1); %></pre>
Index: src/doc/tomcat-ug.html
===================================================================
RCS file: /home/cvspublic/jakarta-tomcat/src/doc/tomcat-ug.html,v
retrieving revision 1.19
diff -u -r1.19 tomcat-ug.html
--- src/doc/tomcat-ug.html 2001/10/20 20:58:01 1.19
+++ src/doc/tomcat-ug.html 2001/10/21 13:28:00
@@ -29,18 +29,18 @@
<p>This document is an introduction to the Tomcat 3.3 servlet
container. It should be enough for anyone to install,
- configure, and deploy Tomcat 3.3, or later its later maintenance releases.
+ configure and deploy Tomcat 3.3, or it's maintenance releases.
As well, it answers many questions common to new users. If you have any
comments or suggestions about this document don't hesitate to send them to the
Tomcat <a href="http://jakarta.apache.org/site/mail.html";>mailing
lists</a>.</p>
<p>Since Tomcat 3.3 is a reference implementation of the Servlet 2.2 and
-JSP 1.1 specification, would would be very benefitial to become familiar
-with these documents to better understand much of the behavior that Tomcat
-3.3 implements. The Servlet 2.2 specifications may be obtained
+JSP 1.1 specification, it would be very beneficial to become familiar
+with these documents, to better understand much of the behavior that Tomcat
+3.3 implements. The Servlet 2.2 specification may be obtained
<a href="http://java.sun.com/products/servlet/download.html";>here</a> and the
-JSP 1.1 specifications obtained
+JSP 1.1 specification obtained
<a href="http://java.sun.com/products/jsp/download.html";>here</a></p>
<p>One of the features of Tomcat 3.3 is its upgradability via add-on modules
@@ -232,7 +232,7 @@
<h2><a name="using_tomcat">Using Tomcat 3.3</a></h2>
-<p>A lot of effort has put into making Tomcat easy to use as well as flexible.
+<p>A lot of effort has been put into making Tomcat easy to use as well as flexible.
It comes with a default configuration which should be a good starting point
for most users. Once you have Tomcat 3.3 up and running, there are many
customizations from which you can choose.</p>
@@ -247,7 +247,7 @@
<h3><a name="install_tomcat">Installing Tomcat</a></h3>
-<p>This section deals will installing the Tomcat 3.3 binary archive available
+<p>This section deals with installing the Tomcat 3.3 binary archive available
from the Jakarta Project. It is also possible to install Tomcat 3.3 by
building it from source, but that isn't covered in this document.</p>
@@ -261,17 +261,18 @@
<code>"jakarta-tomcat-<i><version></i>"</code>. You may
rename this directory if you wish. Just remember to adjust
the instructions that follow to use the new name. If you are using
- Linux, you can install the chosen RPM(s).</li>
+ Linux, RPMs may be installed with the command "rpm -Uvh". Type
+ <strong>man rpm</strong> for more info.</li>
</ul>
<h3><a name="env_setup">Environment Setup</a></h3>
<p>There are a number of different methods to start and stop Tomcat 3.3. There
are differences in the environmental setup needed for these methods. This
-section addresses the environmental setup need to using the shell scripts
+section addresses the environmental setup need for using the shell scripts
and batch files provided to simplify starting and stopping Tomcat. This
section also assumes you will be manually starting and stopping Tomcat from
-as shell or MS-DOS window.</p>
+a shell or MS-DOS window.</p>
<ul>
<li>In a shell or DOS window, change to the
@@ -292,14 +293,14 @@
</li>
<li>Unix (bash/sh):<br>
<tt><big>
- JAVA_HOME=/user/local/java/jdk1.3.1; export JAVA_HOME<br>
+ JAVA_HOME=/usr/local/java/jdk1.3.1; export JAVA_HOME<br>
PATH=$JAVA_HOME/bin:$PATH; export PATH<br>
</big></tt>
</li>
<li>Unix (tcsh):<br>
<tt><big>
- setenv JAVA_HOME=/user/local/java/jdk1.3.1<br>
- setenv PATH=$JAVA_HOME/bin:$PATH<br>
+ setenv JAVA_HOME /usr/local/java/jdk1.3.1<br>
+ setenv PATH $JAVA_HOME/bin:$PATH<br>
</big></tt>
</li>
</ol><br><br></li>
@@ -320,14 +321,14 @@
<tt><big>TOMCAT_HOME=/usr/local/jakarta-tomcat-<i><version></i> ;
export TOMCAT_HOME
</big></tt></li>
<li>On UNIX (using tcsh) you should type: <br>
- <tt><big>setenv TOMCAT_HOME=/usr/local/jakarta-tomcat-<i><version></i>
+ <tt><big>setenv TOMCAT_HOME /usr/local/jakarta-tomcat-<i><version></i>
</big></tt></li>
</ol><br><br></li>
<li><a name="out_of_env"></a>If you are using Win9x, you will need to deal
with the potential <b>"Out of environment space"</b> problem, if you
haven't already. In the standard installation of Win9x, the default
- amount of environment space provided to MS-DOS windows is to small for
+ amount of environment space provided to MS-DOS windows is too small for
Tomcat's batch files to run. There are several ways to increase the
size of the environment space.
<br><br>
@@ -366,7 +367,7 @@
<p>Once you're sure they work, you may wish to set the environment
variables in a configuration file: C:/AUTOEXEC.BAT for Windows, ~/.bash_profile
-or ~/.cshrc, etc. Alternatively, you could customize Tomcats script or
+or ~/.cshrc, etc. Alternatively, you could customize Tomcat's script or
batch files to incorporate the environment settings.</p>
<h3><a name="starting_tomcat">Starting Tomcat</a></h3>
@@ -404,7 +405,7 @@
systems, you can switch to the MS-DOS window to see if this test has
appeared.</p>
-<p>As you might guess from the above log text, default Tomcat 3.3 configuration
+<p>As you might guess from the above log text, the default Tomcat 3.3 configuration
will service HTTP requests on port 8080. If you start your browser and open
<a href="http://localhost:8080/";>http://localhost:8080/</a> you will see Tomcat
3.3's Welcome page.</p>
@@ -470,7 +471,7 @@
<table border="1">
<tr><th bgcolor="#c0c0c0">File</th><th bgcolor="#c0c0c0">Description</th></tr>
<tr><td>cpappend.bat</td><td>This batch file is used by <code>tomcat.bat</code>
- to build a classpath in a couple of <code>tomcat.bat's</code> other
+ to build a classpath in a couple of <code>tomcat.bat</code>'s other
functions. It is not executed during Tomcat start and stop functions.</td></tr>
<tr><td>jspc.sh</td><td>Shell script to invoke JSPC on Unix based systems. It
uses <code>tomcat.sh</code> with the "jspc" option to pre-translate
@@ -515,7 +516,7 @@
<p>You may have noted that <code>tomcat.sh</code> and <code>tomcat.bat</code>
are the primary scripts. They are the scripts that actually perform the
"actions". The list of actions, as well as additional environment
-variables, they support is described in the
+variables they support, are described in the
<a href="#tomcat_actions">next section</a>.</p>
<p>Note that most actions involve starting the
@@ -563,16 +564,16 @@
Java VM options may be specified in the TOMCAT_OPTS environment
variable.</td></tr>
<tr><td>env</td><td>Sets the TOMCAT_HOME and CLASSPATH environment variables
to match Tomcat's runtime environment. This is useful for compiling
- servlets or other Java files for use within Tomcat. For best results, insure
+ servlets or other Java files for use within Tomcat. For best results, ensure
TOMCAT_HOME is set to an absolute path. If set to "."
or "..", the CLASSPATH environment variable will be invalid if
you leave the current directory.</td></tr>
<tr><td>jspc</td><td>Pre-translates specified JSP pages to Java files.
Java VM options may be specified in the JSPC_OPTS environment variable.</td></tr>
<tr><td>estart</td><td>Starts Tomcat without reading the server.xml file.
- Instead the set of modules make up the instance of Tomcat is created
- internally by org.apache.tomcat.startup.EmbeddedTomcat. This command is
- useful for testing customized versions of the EmbeddedTomcat class when
+ Instead the set of modules making up the instance of Tomcat is created
+ internally by org.apache.tomcat.startup.EmbededTomcat. This command is
+ useful for testing customized versions of the EmbededTomcat class when
trying to embed Tomcat in an application. Java VM options may be specified
in the TOMCAT_OPTS environment variable.</td></tr>
</table>
@@ -709,80 +710,80 @@
<th bgcolor="#c0c0c0" WIDTH="85%">Contents</th>
</tr>
<tr>
- <td WIDTH="15%" align="center">bin</td>
+ <td WIDTH="15%" align="left">bin</td>
<td WIDTH="85%"> Startup/shutdown scripts and other useful files.</td>
</tr>
<tr>
- <td WIDTH="15%" align="center">conf</td>
+ <td WIDTH="15%" align="left">conf</td>
<td WIDTH="85%"> <a href="#configuring_server">Configuration files</a>,
including modules.xml, server.xml, and a number of
apps-<i><name></i>.xml.</td>
</tr>
<tr>
- <td width="15%" align="center">conf/auto</td>
+ <td width="15%" align="left">conf/auto</td>
<td width="85%">Directory where auto-generated configuration files are
written.</td>
</tr>
<tr>
- <td width="15%" align="center">conf/jk</td>
+ <td width="15%" align="left">conf/jk</td>
<td width="85%">Directory containing mod_jk specific configuration files.</td>
</tr>
<tr>
- <td width="15%" align="center">conf/jserv</td>
+ <td width="15%" align="left">conf/jserv</td>
<td width="85%">Directory containing mod_jserv specific configuration files.</td>
</tr>
<tr>
- <td width="15%" align="center">conf/users</td>
+ <td width="15%" align="left">conf/users</td>
<td width="85%">Directory containing user name/password configuration files.
These are used by the SimpleRealm module for authentication.</td>
</tr>
<tr>
- <td WIDTH="15%" align="center">doc</td>
+ <td WIDTH="15%" align="left">doc</td>
<td WIDTH="85%">Miscellaneous documents regarding Tomcat.</td>
</tr>
<tr>
- <td WIDTH="15%" align="center">lib</td>
+ <td WIDTH="15%" align="left">lib</td>
<td WIDTH="85%">Jar files that are used for starting and stopping Tomcat.</td>
</tr>
<tr>
- <td width="15%" align="center">lib/container</td>
+ <td width="15%" align="left">lib/container</td>
<td width="85%">Jar files that make up the Tomcat server classes. Any
Jar file in this directory is automatically included in Tomcat's
<b>Server Classloader</b>. See
<a href="#configuring_classes">Configuring Classes</a>.</td>
</tr>
<tr>
- <td width="15%" align="center">lib/common</td>
+ <td width="15%" align="left">lib/common</td>
<td width="85%">Jar files that contain classes shared between the Tomcat
server and all web applications. Any Jar file in this directory is
automatically included in Tomcat's <b>Common Classloader</b>. See
<a href="#configuring_classes">Configuring Classes</a>.</td>
</tr>
<tr>
- <td width="15%" align="center">lib/apps</td>
+ <td width="15%" align="left">lib/apps</td>
<td width="85%">Jar files that contain classes shared between all web
applications. Any Jar file in this directory is automatically included
in Tomcat's <b>Apps Classloader</b>. See
<a href="#configuring_classes">Configuring Classes</a>.</td>
</tr>
<tr>
- <td WIDTH="15%" align="center"><a name="logs_dir_defn">logs</a></td>
+ <td WIDTH="15%" align="left"><a name="logs_dir_defn">logs</a></td>
<td WIDTH="85%"> This is where Tomcat places its log files by default.</td>
</tr>
<tr>
- <td width="15%" align="center">modules</td>
+ <td width="15%" align="left">modules</td>
<td width="85%">Directory where "add-on" WARs are placed.</td>
</tr>
<tr>
- <td width="15%" align="center">native</td>
+ <td width="15%" align="left">native</td>
<td width="85%">Base directory for native source code.</td>
</tr>
<tr>
- <td WIDTH="15%" align="center">src</td>
+ <td WIDTH="15%" align="left">src</td>
<td WIDTH="85%">Currently empty. Tomcat's source code isn't currently
part of the binary distribution.</td>
</tr>
<tr>
- <td WIDTH="15%" align="center">webapps</td>
+ <td WIDTH="15%" align="left">webapps</td>
<td WIDTH="85%"> Sample web applications. Any .war files placed
here will be automatically expanded. See <a href="#deploy_war">Deploying WAR
Files</a>.</td>
</tr>
@@ -793,7 +794,7 @@
<table border="1" width="75%" VALIGN="center">
<tr>
- <td width="15%" align="center"> <a name="work_dir_defn"> work</a></td>
+ <td width="15%" align="left"> <a name="work_dir_defn"> work</a></td>
<td width="85%"> Where Tomcat
places intermediate files (such as compiled JSP files) during
its work. If you delete this directory while Tomcat is running
@@ -801,7 +802,7 @@
</td>
</tr>
<tr>
- <td width="15%" align="center">classes</td>
+ <td width="15%" align="left">classes</td>
<td width="85%"> Any class that you add to this directory will
find its place in Tomcat's classpath.
</td>
@@ -827,7 +828,7 @@
<tr><td class="clt_data">lib/container</td></tr>
<tr><td class="clt_label">default contents:</td></tr>
<tr>
- <td class="clt_data">crimson.jar<br>facade22.jar<br>
+ <td
+class="clt_data">commons-collections.jar<br>commons-dbcp.jar<br>commons-pool.jar<br>crimson.jar<br>facade22.jar<br>
jasper.jar<br>jaxp.jar<br>tomcat_modules.jar<br>tomcat_util.jar<br>
tomcat-startup.jar<br>xalan.jar</td></tr>
</table></td>
@@ -852,7 +853,7 @@
<tr><td class="clt_data">lib/common</td></tr>
<tr><td class="clt_label">default contents:</td></tr>
<tr>
- <td
class="clt_data">connector_util.jar<br>core_util.jar<br>jasper-runtime.jar<br>
+ <td
+class="clt_data">connector_util.jar<br>core_util.jar<br>etomcat.jar<br>jasper-runtime.jar<br>
servlet.jar<br>tomcat_core.jar</td></tr>
</table>
</td>
@@ -971,7 +972,7 @@
<p>The <code>ContextXmlReader</code> module supports a <code>config</code>
parameter which specifies the file to read. Like <code>server.xml</code>,
-additional files are read based on the pattern <code><i>base</i>-*.xml</code>.
+additional files are read based on the pattern <code><base>-*.xml</code>.
Thus, specifying <code>config="conf/myapps.xml"</code> would read
<code>conf/myapps.xml</code>, if it exists, plus all files in the
<code>conf</code> directory matching the pattern <code>myapps-*.xml</code>.</p>
@@ -1048,7 +1049,7 @@
<tr><td><<a href="serverxml.html#SessionIdGenerator">SessionIdGenerator</a><br>
randomClass="java.security.SecureRandom"<br>
randomFile="/dev/urandom"
/></td><td> </td>
- <td>Generates session ID's for requests that need a new session.</td></tr>
+ <td>Generates session IDs for requests that need a new session.</td></tr>
<tr><td><<a href="serverxml.html#LogSetter">LogSetter</a>
name="servlet_log"<br>
timestamps="true"<br>
