glenn 2002/09/08 10:56:04
Modified: webapps/tomcat-docs index.xml project.xml
Added: webapps/tomcat-docs jasper-howto.xml cgi-howto.xml
ssi-howto.xml
Log:
Add three new HOT-TO documents
Revision Changes Path
1.15 +8 -3 jakarta-tomcat-4.0/webapps/tomcat-docs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/index.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- index.xml 18 Aug 2002 00:54:26 -0000 1.14
+++ index.xml 8 Sep 2002 17:56:04 -0000 1.15
@@ -58,6 +58,8 @@
are responsible for installing, configuring, and operating a Tomcat 4 server.
</p>
<ul>
+<li><a href="cgi-howto.html"><strong>CGI HOW-TO</strong></a> - Configuring
+ Tomcat to use CGI (Common Gateway Interface).</li>
<li><a href="config/index.html"><strong>Server Configuration Reference</strong></a>
- Reference manual that documents all available elements and attributes
that may be placed into a Tomcat 4 <code>conf/server.xml</code> file.
@@ -72,6 +74,8 @@
<li><a href="jndi-resources-howto.html"><strong>JNDI Resources HOW-TO</strong></a>
- Configuring standard and custom resources in the JNDI naming context
that is provided to each web application.</li>
+<li><a href="jasper-howto.html"><strong>JSP Engine Config HOW-TO</strong></a>
+ - The Jasper 2 JSP Engine. How it works and how to configure it. </li>
<li><a href="manager-howto.html"><strong>Manager App HOW-TO</strong></a> -
Operating the <code>Manager</code> web app to deploy, undeploy, and
redeploy applications while Tomcat is running.</li>
@@ -87,10 +91,11 @@
HOW-TO</strong></a> - Configuring and using a Java Security Manager to
support fine-grained control over the behavior of your web applications.
</li>
+<li><a href="ssi-howto.html"><strong>SSI HOW-TO</strong></a> - Configuring
+ Tomcat to use SSI (Server Side Include).</li>
<li><a href="ssl-howto.html"><strong>SSL Configuration HOW-TO</strong></a> -
- Installing and
- configuring SSL support so that your Tomcat will serve requests using
- the <code>https</code> protocol.</li>
+ Installing and configuring SSL support so that your Tomcat will serve
+ requests using the <code>https</code> protocol.</li>
</ul>
</section>
1.16 +3 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/project.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- project.xml 18 Aug 2002 00:53:54 -0000 1.15
+++ project.xml 8 Sep 2002 17:56:04 -0000 1.16
@@ -23,15 +23,18 @@
</menu>
<menu name="Administrators">
+ <item name="CGI HOW-TO" href="cgi-howto.html"/>
<item name="Config. Reference" href="config/index.html"/>
<item name="Class Loader HOW-TO" href="class-loader-howto.html"/>
<item name="JNDI DataSource HOW-TO"
href="jndi-datasource-examples-howto.html"/>
<item name="JNDI Resources HOW-TO" href="jndi-resources-howto.html"/>
+ <item name="JSP Engine Config HOW-TO" href="jasper-howto.html"/>
<item name="Manager App HOW-TO" href="manager-howto.html"/>
<item name="Proxy Support HOW-TO" href="proxy-howto.html"/>
<item name="Realm HOW-TO" href="realm-howto.html"/>
<item name="Security Mgr. HOW-TO" href="security-manager-howto.html"/>
+ <item name="SSI Config HOW-TO" href="ssi-howto.html"/>
<item name="SSL Config HOW-TO" href="ssl-howto.html"/>
</menu>
1.1 jakarta-tomcat-4.0/webapps/tomcat-docs/jasper-howto.xml
Index: jasper-howto.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document>
&project;
<properties>
<author email="[EMAIL PROTECTED]">Glenn L. Nielsen</author>
<title>Jasper 2 JSP Engine How To</title>
</properties>
<body>
<section name="Table of Contents">
<p>
<a href="#Introduction">Introduction</a><br />
<a href="#Upgrading">Upgrading</a><br />
<a href="#Configuration">Configuration</a><br />
<a href="#Production Configuration">Production Configuration</a><br />
<a href="#Using Jikes">Using Jikes</a><br />
</p>
</section>
<section name="Introduction">
<p>Starting with Tomcat 4.1, Tomcat uses the Jasper 2 JSP Engine to implement
the <a href="http://java.sun.com/products/jsp/";>JavaServer Pages 1.2</a>
specification.</p>
<p>Jasper 2 has been redesigned to significantly improve performance over
the orignal Jasper. In addition to general code improvements the following
changes were made:
<ul>
<li><strong>JSP Custom Tag Pooling</strong> - The java objects instantiated
for JSP Custom Tags can now be pooled and reused. This significantly boosts
the performance of JSP pages which use custom tags.</li>
<li><strong>Background JSP compilation</strong> - If you make a change to
a JSP page which had already been compiled Jasper 2 can recompile that
page in the background. The previously compiled JSP page will still be
available to serve requests. Once the new page has been compiled
successfully it will replace the old page. This helps improve availablity
of your JSP pages on a production server.</li>
<li><strong>Recompile JSP when included page changes</strong> - Jasper 2
can now detect when a page included at compile time from a JSP has changed
and then recompile the parent JSP.</li>
<li><strong>Ant used to compile JSP pages</strong> - The
<a href="http://jakarta.apache.org/ant/";>Ant Build Tool</a> is now
used to perform JSP java source code compilation.</li>
</ul>
</p>
<p>Jasper is implemented using the servlet class
<code>org.apache.jasper.servlet.JspServlet</code>.</p>
</section>
<section name="Upgrading">
<p>Upgrading to Tomcat 4.1 and Jasper 2 from an earlier version of
Tomcat and/or Jasper.</p>
<p>Jasper 2 generates different java source code from Jasper 1. You
must remove all previous class files generated for your JSP pages
from your <code>work</code> directory.</p>
<p>Jasper 2 implements JSP Custom Tag Pooling. This can cause
JSP custom tags which are not compliant with the JSP specification to fail
or behave inconsistently. When upgrading from a version of Tomcat earlier
than 4.1 you should test to make sure your JSP pages which use custom tags
are working correctly.</p>
</section>
<section name="Configuration">
<p>By default Jasper is configured for use when doing web application
development. See the section <a href="#Production Configuration">
Production Configuration</a> for information on configuring Jasper
for use on a production Tomcat server.</p>
<p>The servlet which implements Jasper is configured using init parameters
in your global <code>$CATALINA_BASE/conf/web.xml</code>.
<ul>
<li><strong>checkInterval</strong> - If development is false and reloading is
true, background compiles are enabled. checkInterval is the time in seconds
between checks to see if a JSP page needs to be recompiled. Default
<code>300</code> seconds.</li>
<li><strong>compiler</strong> - Which compiler Ant should use to compile JSP
pages. See the Ant documenation for more information. Default
<code>javac</code>.</li>
<li><strong>classdebuginfo</strong> - Should the class file be compiled with
debugging information? <code>true</code> or <code>false</code>, default
<code>true</code>.
</li>
<li><strong>classpath</strong> - What class path should I use while compiling
generated servlets? By default the classpath is created dynamically based on
the current web application.</li>
<li><strong>development</strong> - Is Jasper used in development mode (will
check for JSP modification on every access)? <code>true</code> or
<code>false</code>, default <code>true</code>.</li>
<li><strong>enablePooling</strong> - Determines whether tag handler pooling is
enabled. <code>true</code> or <code>false</code>, default <code>true</code>.
</li>
<li><strong>ieClassId</strong> - The class-id value to be sent to Internet
Explorer when using <jsp:plugin> tags. Default
<code>clsid:8AD9C840-044E-11D1-B3E9-00805F499D93</code>.</li>
<li><strong>javaEncoding</strong> - Java file encoding to use for generating
java source files. Default <code>UTF8</code>.</li>
<li><strong>keepgenerated</strong> - Should we keep the generated Java source
code for each page instead of deleting it? <code>true</code> or
<code>false</code>, default <code>true</code>.</li>
<li><strong>largefile</strong> - Should we store the static content of JSP
pages in external data files, to reduce the size of the generated servlets?
<code>true</code> or <code>false</code>, default <code>false</code>.</li>
<li><strong>logVerbosityLevel</strong> - The level of detailed messages to be
produced by this servlet. Increasing levels cause the generation of more
messages. Valid values are <code>FATAL, ERROR, WARNING, INFORMATION,</code>
and <code>DEBUG</code>. Default <code>WARNING</code>.</li>
<li><strong>mappedfile</strong> - Should we generate static content with one
print statement per input line, to ease debugging?
<code>true</code> or <code>false</code>, default <code>false</code>.</li>
<li><strong>reloading</strong> - Should Jasper check for modified JSPs?
<code>true</code> or <code>false</code>, default <code>true</code>.</li>
<li><strong>scratchdir</strong> - What scratch directory should we use when
compiling JSP pages? Default is the work directory for the current web
application.</li>
</ul>
</p>
</section>
<section name="Production Configuration">
<p>When using Jasper 2 in a production Tomcat server you should consider
making the following changes from the default configuration.
<ul>
<li><strong>development</strong> - To enable background compilation of JSP
pages set this to <code>false</code>.</li>
<li><strong>compiler</strong> - The internal JVM javac compiler used by Ant
has a known memory leak. If you anticipate that JSP pages will get recompiled
frequently consider using an external compiler such as <code>jikes</code>.</li>
</ul>
</p>
</section>
<section name="Using Jikes">
<p>If you wish to use
<a href="http://oss.software.ibm.com/developerworks/opensource/jikes/";>
Jikes</a> to compile JSP pages:
<ul>
<li>Download and install jikes.</li>
<li>Set the init parameter <code>compiler</code> to <code>jikes</code>.</li>
<li>Define the property <code>-Dbuild.compiler.emacs=true</code> when starting
Tomcat.</li>
<li>If you get an error reporting that jikes can't use UTF8 encoding, try
setting the init parameter <code>javaEncoding</code> to
<code>ISO-8859-1</code>.</li>
</ul>
</p>
</section>
</body>
</document>
1.1 jakarta-tomcat-4.0/webapps/tomcat-docs/cgi-howto.xml
Index: cgi-howto.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document>
&project;
<properties>
<author email="[EMAIL PROTECTED]">Glenn L. Nielsen</author>
<title>CGI How To</title>
</properties>
<body>
<section name="Introduction">
<p>The CGI (Common Gateway Interface) defines a way for a web server to
interact with external content-generating programs, which are often
referred to as CGI programs or CGI scripts.
</p>
<p>Within Tomcat CGI support can be added when using Tomcat as your
HTTP server and you require CGI support. Typically this is done
during development when you don't want to run a web server like Apache.</p>
<p>CGI support is implemented using the servlet class
<code>org.apache.catalina.servlets.CGIServlet</code>. Traditionally,
this servlet is mapped to the URL pattern "/cgi-bin/*".</p>
<p>By default CGI support is disabled in Tomcat.</p>
</section>
<section name="Installation">
<p><strong>CAUTION</strong> - CGI scripts are used to execute programs
external to the Tomcat JVM. If you are using the Java SecurityManager this
will bypass your security policy configuration in <code>catalina.policy.</code></p>
<p>Rename <code>$CATALINA_BASE/server/lib/servlets-cgi.renametojar</code>
to <code>$CATALINA_BASE/server/lib/servlets-cgi.jar</code>.</p>
<p>Remove the XML comments from around the CGI servlet and servlet-mapping
configuration in <code>$CATALINA_BASE/conf/web.xml</code>.</p>
</section>
<section name="Configuration">
<p>There are several servlet init parameters which can be used to
configure the behaviour of the CGI servlet.
<ul>
<li><strong>cgiPathPrefix</strong> - The CGI search path will start at
the web application root directory + File.separator + this prefix.
The default cgiPathPrefix is <code>/WEB-INF/cgi</code></li>
<li><strong>clientInputTimeout</strong> - The time (in milliseconds) to
wait for input from the browser before assuming that there is none.
Default is <code>100</code> seconds.</li>
<li><strong>debug</strong> - Debugging detail level for messages logged
by this servlet. Default 0.</li>
</ul>
</p>
</section>
</body>
</document>
1.1 jakarta-tomcat-4.0/webapps/tomcat-docs/ssi-howto.xml
Index: ssi-howto.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document>
&project;
<properties>
<author email="[EMAIL PROTECTED]">Glenn L. Nielsen</author>
<title>SSI How To</title>
</properties>
<body>
<section name="Introduction">
<p>SSI (Server Side Includes) are directives that are placed in HTML pages,
and evaluated on the server while the pages are being served. They let you
add dynamically generated content to an existing HTML page, without having
to serve the entire page via a CGI program, or other dynamic technology.
</p>
<p>Within Tomcat SSI support can be added when using Tomcat as your
HTTP server and you require SSI support. Typically this is done
during development when you don't want to run a web server like Apache.</p>
<p>Tomcat SSI support implements the same SSI directives as Apache. See the
<a href="http://httpd.apache.org/docs/howto/ssi.html#basicssidirectives";>
Apache Introduction to SSI</a> for information on using SSI directives.</p>
<p>SSI support is implemented using the servlet class
<code>org.apache.catalina.ssi.SSIServlet</code>. Traditionally, this servlet
is mapped to the URL pattern "*.shtml".</p>
<p>By default SSI support is disabled in Tomcat.</p>
</section>
<section name="Installation">
<p><strong>CAUTION</strong> - SSI directives can be used to execute programs
external to the Tomcat JVM. If you are using the Java SecurityManager this
will bypass your security policy configuration in <code>catalina.policy.</code>
</p>
<p>Rename <code>$CATALINA_BASE/server/lib/servlets-ssi.renametojar</code>
to <code>$CATALINA_BASE/server/lib/servlets-ssi.jar</code>.</p>
<p>Remove the XML comments from around the SSI servlet and servlet-mapping
configuration in <code>$CATALINA_BASE/conf/web.xml</code>.</p>
</section>
<section name="Configuration">
<p>There are several servlet init parameters which can be used to
configure the behaviour of the SSI servlet.
<ul>
<li><strong>buffered</strong> - Should output from this servlet be buffered?
(0=false, 1=true) Default 0 (false).</li>
<li><strong>debug</strong> - Debugging detail level for messages logged
by this servlet. Default 0.</li>
<li><strong>expires</strong> - The number of seconds before a page with SSI
directives will expire. Default behaviour is for all SSI directives to be
evaluated for every request.</li>
<li><strong>isVirtualWebappRelative</strong> - Should "virtual" SSI directive
paths be interpreted as relative to the context root, instead of the server
root? (0=false, 1=true) Default 0 (false).</li>
</ul>
</p>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
