tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r620335 - in /tomcat/trunk/webapps/docs: config/project.xml config/systemprops.xml tomcat-docs.xsl
Date Sun, 10 Feb 2008 21:33:36 GMT
Author: markt
Date: Sun Feb 10 13:33:35 2008
New Revision: 620335

URL: http://svn.apache.org/viewvc?rev=620335&view=rev
Log:
Add a page to the config docs detailing the various system properties that are available.

Added:
    tomcat/trunk/webapps/docs/config/systemprops.xml   (with props)
Modified:
    tomcat/trunk/webapps/docs/config/project.xml
    tomcat/trunk/webapps/docs/tomcat-docs.xsl

Modified: tomcat/trunk/webapps/docs/config/project.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/project.xml?rev=620335&r1=620334&r2=620335&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/project.xml (original)
+++ tomcat/trunk/webapps/docs/config/project.xml Sun Feb 10 13:33:35 2008
@@ -74,6 +74,10 @@
         <item name="Deployer"              href="cluster-deployer.html"/>
         <item name="ClusterListener"       href="cluster-listener.html"/>
     </menu>
+
+    <menu name="Global Settings">
+        <item name="System properties"     href="systemprops.html"/>
+    </menu>
   </body>
 
 </project>

Added: tomcat/trunk/webapps/docs/config/systemprops.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/systemprops.xml?rev=620335&view=auto
==============================================================================
--- tomcat/trunk/webapps/docs/config/systemprops.xml (added)
+++ tomcat/trunk/webapps/docs/config/systemprops.xml Sun Feb 10 13:33:35 2008
@@ -0,0 +1,295 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document [
+  <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="systemprops.html">
+
+  &project;
+
+  <properties>
+    <title>System Properties</title>
+  </properties>
+
+<body>
+
+<section name="Introduction">
+  <p>The follow sections list the system properties that may be set to modify
+  the default Tomcat behaviour.</p>
+</section>
+
+
+<section name="Clustering">
+  <properties>
+
+    <property name="org.apache.catalina. tribes.dns_lookups">
+      <p>If <code>true</code>, the clustering module will attempt to use
DNS to
+      resolve any host names provided in the cluster configuration. If not
+      specified, the default value of <code>false</code> will be used.</p>
+    </property>
+
+  </properties>
+
+</section>
+
+
+<section name="Jasper">
+  <properties>
+
+    <property name="org.apache.jasper.compiler. Generator.VAR_EXPRESSIONFACTORY">
+      <p>The name of the variable to use for the expression language expression
+      factory. If not specified, the default value of
+      <code>_el_expressionfactory</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.compiler. Generator.VAR_INSTANCEMANAGER">
+      <p>The name of the variable to use for the instance manager factory. If
+      not specified, the default value of <code>_jsp_instancemanager</code> will
+      be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.runtime. BodyContentImpl.LIMIT_BUFFER">
+      <p>If <code>true</code>, any tag buffer that expands beyond
+      <code>org.apache.jasper.Constants.DEFAULT_TAG_BUFFER_SIZE</code> will be
+      destroyed and a new buffer created of the default size. If not specified,
+      the default value of <code>false</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.runtime. JspFactoryImpl.USE_POOL">
+      <p>If <code>true</code>, a ThreadLocal <code>PageContext</code>
pool will
+      be used. If not specified, the default value of <code>true</code> will
be
+      used.</p>
+    </property>
+
+    <property name="org.apache.jasper.runtime. JspFactoryImpl.POOL_SIZE">
+      <p>The size of the ThreadLocal <code>PageContext</code>. If not specified,
+      the default value of <code>8</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. JSP_SERVLET_BASE">
+      <p>The base class of the Servlets generated from the JSPs. If not
+      specified, the default value of
+      <code>org.apache.jasper.runtime.HttpJspBase</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. SERVICE_METHOD_NAME">
+      <p>The name of the service method called by the base class. If not
+      specified, the default value of <code>_jspService</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. SERVLET_CLASSPATH">
+      <p>The name of the ServletContext attribute that provides the classpath
+      for the JSP. If not specified, the default value of
+      <code>org.apache.catalina.jsp_classpath</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. JSP_FILE">
+      <p>The name of the request attribute for <code>&lt;jsp-file&gt;</code>
+      element of a servlet definition. If present on a request, this overrides
+      the value returned by <code>request.getServletPath()</code> to select the
+      JSP page to be executed. If not specified, the default value of
+      <code>org.apache.catalina.jsp_file</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. PRECOMPILE">
+      <p>The name of the query parameter that causes the JSP engine to just
+      pregenerate the servlet but not invoke it. If not specified, the default
+      value of <code>org.apache.catalina.jsp_precompile</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. JSP_PACKAGE_NAME">
+      <p>The default package name for compiled jsp pages. If not specified, the
+      default value of <code>org.apache.jsp</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. TAG_FILE_PACKAGE_NAME">
+      <p>The default package name for tag handlers generated from tag files. If
+      not specified, the default value of <code>org.apache.jsp.tag</code> will
+      be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. ALT_DD_ATTR">
+      <p>The servlet context attribute under which the alternate deployment
+      descriptor for this web application is stored. If not specified, the
+      default value of <code>org.apache.catalina.deploy.alt_dd</code> will
+      be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. TEMP_VARIABLE_NAME_PREFIX">
+      <p>Prefix to use for generated temporary variable names. If not specified,
+      the default value of <code>_jspx_temp</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.jasper.Constants. USE_INSTANCE_MANAGER_FOR_TAGS">
+      <p>If <code>true</code>, the instance manager is used to obtain tag
+      handler instances. If not specified, <code>false</code> will be used.</p>
+    </property>
+
+  </properties>
+
+</section>
+
+
+<section name="Security">
+
+  <properties>
+
+    <property name="org.apache.catalina.connector. RECYCLE_FACADES">
+      <p>If this is <code>true</code> or if a security manager is in use
a new
+      facade object will be created for each request. If not specified, the
+      default value of <code>false</code> will be used.</p>
+    </property>
+
+    <property
+    name="org.apache.catalina.connector. CoyoteAdapter.ALLOW_BACKSLASH">
+      <p>If this is <code>true</code> the '\' character will be permitted
as a
+      path delimiter. If not specified, the default value of <code>false</code>
+      will be used.</p>
+    </property>
+
+    <property
+    name="org.apache.tomcat.util.buf. UDecoder.ALLOW_ENCODED_SLASH">
+      <p>If this is <code>true</code> '%2F' and '%5C' will be permitted
as path
+      delimiters. If not specified, the default value of <code>false</code> will
+      be used.</p>
+    </property>
+
+  </properties>
+
+</section>
+
+
+<section name="Specification">
+
+  <properties>
+
+    <property name="org.apache.catalina. STRICT_SERVLET_COMPLIANCE">
+      <p>If this is <code>true</code> the following actions will occur:
+      <ul>
+      <li>any wrapped request or response object passed to an application
+      dispatcher will be checked to ensure that it has wrapped the original
+      request or response. (SRV.8.2 / SRV.14.2.5.1)
+      </li>
+      <li>a call to <code>Response.getWriter()</code> if no character encoding
+      has been specified will result in subsequent calls to
+      <code>Response.getCharacterEncoding()</code> returning
+      <code>ISO-8859-1</code> and the <code>Content-Type</code> response
header
+      will include a <code>charset=ISO-8859-1</code> component. (SRV.15.2.22.1)
+      </li>
+      <li>every request that is associated with a session will cause the
+      session's last accessed time to be updated regardless of whether or not
+      the request explicity accesses the session. (SRV.7.6)  
+      </li>
+      </ul>
+      </p>
+    </property>
+
+    <property
+    name="org.apache.catalina.session. StandardSession.ACTIVITY_CHECK">
+      <p>If this is <code>true</code> or if
+      <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> is
+      <code>true</code> Tomcat will track the number of active requests for each
+      session. When determining if a session is valid, any session with at least
+      one active request will always be considered valid. If not specified, the
+      default value of <code>false</code> will be used.</p>
+    </property>
+
+  </properties>
+
+</section>
+
+
+<section name="Other">
+
+  <properties>
+
+    <property name="catalina.useNaming">
+      <p>If this is <code>false</code> it will override the
+      <code>useNaming</code> attribute for all <a href="context.html">
+      Context</a> elements.</p>
+    </property>
+
+    <property name="jvmRoute">
+      <p>Provides a default value for the <code>jvmRoute</code> attribute
of the
+      <a href="engine.html">Engine</a> element. It does not override the a value
+      configured on the <a href="engine.html">Engine</a> element.</p>
+    </property>
+
+    <property
+    name="org.apache.catalina.loader. WebappClassLoader.ENABLE_CLEAR_REFERENCES">
+      <p>If <code>true</code>, Tomcat attempts to null out any static or
final
+      fields from loaded classes when a web application is stopped as a work
+      around for apparent garbage collection bugs and application coding errors.
+      </p>
+      <p>There have been some issues reported with log4j when this option is
+      <code>true</code>.</p>
+      <p>Applications without memory leaks using recent JVMs should operate
+      correctly with this option set to <code>false</code>.</p>
+      <p>If not specified, the default value of <code>true</code> will
be used.
+      </p>
+    </property>
+
+    <property name="catalina.config">
+      <p>The URL for the catalina.properties configuration file.</p>
+    </property>
+
+    <property name="tomcat.util.buf.StringCache.byte.enabled">
+      <p>If <code>true</code>, the String cache is enabled for
+      <code>ByteChunk</code>. If not specified, the default value of
+      <code>false</code> will be used.</p>
+    </property>
+
+    <property name="tomcat.util.buf.StringCache.char.enabled">
+      <p>If <code>true</code>, the String cache is enabled for
+      <code>CharChunk</code>. If not specified, the default value of
+      <code>false</code> will be used.</p>
+    </property>
+
+    <property name="tomcat.util.buf.StringCache.trainThreshold">
+      <p>The number of times <code>toString()</code> must be called before
the
+      cache is activated. If not specified, the default value of
+      <code>20000</code> will be used.</p>
+    </property>
+
+    <property name="tomcat.util.buf.StringCache.cacheSize">
+      <p>The size of the String cache. If not specified, the default value of
+      <code>200</code> will be used.</p>
+    </property>
+
+    <property name="tomcat.util.buf.StringCache.maxStringSize">
+      <p>The maximum length of String that will be cached. If not specified, the
+      default value of <code>128</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.tomcat.util. http.FastHttpDateFormat.CACHE_SIZE">
+      <p>The size of the cache to use parsed and formatted date value. If not
+      specified, the default value of <code>1000</code> will be used.</p>
+    </property>
+
+    <property name="org.apache.tomcat.util. net.NioSelectorShared">
+      <p>If <code>true</code>, use a shared selector for servlet write/read.
If
+      not specified, the default value of <code>true</code> will be used.</p>
+    </property>
+
+  </properties>
+
+</section>
+
+
+</body>
+</document>

Propchange: tomcat/trunk/webapps/docs/config/systemprops.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: tomcat/trunk/webapps/docs/config/systemprops.xml
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Modified: tomcat/trunk/webapps/docs/tomcat-docs.xsl
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/tomcat-docs.xsl?rev=620335&r1=620334&r2=620335&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/tomcat-docs.xsl (original)
+++ tomcat/trunk/webapps/docs/tomcat-docs.xsl Sun Feb 10 13:33:35 2008
@@ -154,7 +154,7 @@
       <xsl:comment>PAGE FOOTER</xsl:comment>
       <tr><td colspan="2">
         <div align="center"><font color="{$body-link}" size="-1"><em>
-        Copyright &#169; 1999-2006, Apache Software Foundation
+        Copyright &#169; 1999-2008, Apache Software Foundation
         </em></font></div>
       </td></tr>
 
@@ -288,6 +288,30 @@
             <xsl:if test="@required != 'true'">
               <code><xsl:value-of select="@name"/></code>
             </xsl:if>
+          </td>
+          <td align="left" valign="center">
+            <xsl:apply-templates/>
+          </td>
+        </tr>
+      </xsl:for-each>
+    </table>
+  </xsl:template>
+
+  <!-- Process a properties list with nested property elements -->
+  <xsl:template match="properties">
+    <table border="1" cellpadding="5">
+      <tr>
+        <th width="15%" bgcolor="{$attributes-color}">
+          <font color="#ffffff">Property</font>
+        </th>
+        <th width="85%" bgcolor="{$attributes-color}">
+          <font color="#ffffff">Description</font>
+        </th>
+      </tr>
+      <xsl:for-each select="property">
+        <tr>
+          <td align="left" valign="center">
+            <code><xsl:value-of select="@name"/></code>
           </td>
           <td align="left" valign="center">
             <xsl:apply-templates/>



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Mime
View raw message