You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by bu...@apache.org on 2003/05/14 05:20:05 UTC

DO NOT REPLY [Bug 19910] New: - Cleanup for jakarta-tomcat-5/RUNNING.txt

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=19910>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=19910

Cleanup for jakarta-tomcat-5/RUNNING.txt

           Summary: Cleanup for jakarta-tomcat-5/RUNNING.txt
           Product: Tomcat 5
           Version: Unknown
          Platform: All
               URL: http://http://
        OS/Version: Other
            Status: NEW
          Severity: Minor
          Priority: Other
         Component: Unknown
        AssignedTo: tomcat-dev@jakarta.apache.org
        ReportedBy: pepper@rockefeller.edu


Grammar cleanup, including subject-verb agreement,
Make $CATALINA_BASE & $CATALINA_HOME consistent.
Remove implication that $CATALINA_BASE files should only include those different than standard files in 
$CATALINA_HOME; I don't believe if a file's not in $CATALINA_BASE the 'default' is picked up from 
$CATALINA_HOME, but am not absolutely certain.

Someone should verify that Windows doesn't restrict listeners <= 1024 (I'm pretty sure Win98 doesn't, 
but don't know about W2k3).

Index: RUNNING.txt
================================================================
===
RCS file: /home/cvspublic/jakarta-tomcat-5/RUNNING.txt,v
retrieving revision 1.1
diff -u -r1.1 RUNNING.txt
--- RUNNING.txt	1 Aug 2002 21:00:18 -0000	1.1
+++ RUNNING.txt	14 May 2003 03:13:40 -0000
@@ -6,7 +6,7 @@
 
 This subproject contains Tomcat 5, a server that implements the Servlet 2.4
 and JSP 2.0 specifications from the Java Community Process
-(http://www.jcp.org).  In order to install and run this container, you must do
+<http://www.jcp.org/>.  In order to install and run this container, you must do
 the following:
 
 
@@ -42,7 +42,7 @@
 * Unpack the binary distribution into a convenient location so that the
   distribution resides in its own directory (conventionally named
   "jakarta-tomcat-5").  For the purposes of the remainder of this document,
-  the symbolic name "<CATALINA_HOME>" is used to refer to the full
+  the symbolic name "$CATALINA_HOME" is used to refer to the full
   pathname of the release directory.
 
 
@@ -50,12 +50,12 @@
 
 Tomcat 5 can be started by executing the following commands:
 
-      <CATALINA_HOME>\bin\startup.bat          (Windows)
+      $CATALINA_HOME\bin\startup.bat          (Windows)
 
-      <CATALINA_HOME>/bin/startup.sh           (Unix)
+      $CATALINA_HOME/bin/startup.sh           (Unix)
 
 After startup, the default web applications included with Tomcat 5 will be
-available by browsing:
+available by visiting:
 
     http://localhost:8080/
 
@@ -69,23 +69,23 @@
 
 Tomcat 5 can be shut down by executing the following command:
 
-      <CATALINA_HOME>\bin\shutdown            (Windows)
+      $CATALINA_HOME\bin\shutdown            (Windows)
 
-      <CATALINA_HOME>/bin/shutdown.sh         (Unix)
+      $CATALINA_HOME/bin/shutdown.sh         (Unix)
 
 
 (4) Advanced Configuration - Multiple Tomcat 5 Instances
 
 In many circumstances, it is desirable to have a single copy of a Tomcat 5
 binary distribution shared among multiple users on the same server.  To make
-this possible, you must pass a "-Dcatalina.base=<CATALINA_BASE>" argument when
-executing the to the startup command (see (2)). In this
-"-Dcatalina.base=<CATALINA_BASE>" argument, replace <CATALINA_BASE> with the
-directory that contains the files unique to your Tomcat 5 instance.
+this possible, you can pass a "-Dcatalina.base=$CATALINA_BASE" argument when
+executing the startup command (see (2)). In this
+"-Dcatalina.base=$CATALINA_BASE" argument, replace $CATALINA_BASE with the
+directory that contains the files for your 'personal' Tomcat 5 instance.
 
-When you use this "-Dcatalina.base=<CATALINA_BASE>" argument, Tomcat 5 will
+When you use this "-Dcatalina.base=$CATALINA_BASE" argument, Tomcat 5 will
 calculate all relative references for files in the following directories based
-on the value of <CATALINA_BASE> instead of <CATALINA_HOME>:
+on the value of $CATALINA_BASE instead of $CATALINA_HOME:
 
 * conf - Server configuration files (including server.xml)
 
@@ -97,24 +97,27 @@
 
 * temp - Directory used by the JVM for temporary files (java.io.tmpdir)
 
-If you do not pass the "-Dcatalina.base=<CATALINA_BASE>" argument to the startup command, 
<CATALINA_BASE> will default to the same value as <CATALINA_HOME> (which means that the same 
directory is used for all relative path resolutions).
+If you do not pass the "-Dcatalina.base=$CATALINA_BASE" argument to the
+startup command, $CATALINA_BASE will default to the same value as
+$CATALINA_HOME (which means that the same directory is used for all
+relative path resolutions).
 
 The administration and manager web applications, which are defined in the
-<CATALINA_BASE>/webapps/admin.xml and <CATALINA_BASE>/webapps/manager.xml will
-not run in that configuration, unless either:
+$CATALINA_BASE/webapps/admin.xml and $CATALINA_BASE/webapps/manager.xml
+files, will not run in that configuration, unless either:
 - The path specified in the docBase attribute of the Context element is made 
-  absolute, and replaced respectively by <CATALINA_HOME>/server/webapps/admin 
-  and <CATALINA_HOME>/server/webapps/manager
-- Copying and linking both web applications in <CATALINA_BASE>, and modify 
-  accordingly the path specified in the docBase attribute of the Context 
-  element
-- Disabling both web applications by removing <CATALINA_BASE>/webapps/admin.xml
-  and <CATALINA_BASE>/webapps/manager.xml
+  absolute, and replaced respectively by $CATALINA_HOME/server/webapps/admin 
+  and $CATALINA_HOME/server/webapps/manager
+- Both web applications are copied or to $CATALINA_BASE, and
+  the path specified in the docBase attribute of the Context 
+  element is modified appropriately
+- Both web applications are disabled by removing
+  $CATALINA_BASE/webapps/admin.xml and $CATALINA_BASE/webapps/manager.xml
 
 
 (5) Troubleshooting:
 
-There are only really 3 things that can go wrong during the stand-alone
+There are only really 3 things likely to go wrong during the stand-alone
 Tomcat 5 install:
 
 1) The most common hiccup is when another web server (or any process for that
@@ -125,26 +128,26 @@
     
    and search for '8080'.  Change it to a port that isn't in use, and is
    greater than 1024, as ports less than or equal to 1024 require superuser
-   access to bind to.
+   access to bind to under UNIX.
    
    Restart Tomcat and you're in business.  Be sure that you replace the "8080"
    in the URL you're using to access Tomcat.  For example, if you change the
-   port to 1977, you would request the URL http://localhost:1977/.
+   port to 1977, you would request the URL http://localhost:1977/ in your browser.
 
 2) An "out of environment space" error when running the batch files in
    Windows 95, 98, or ME operating systems.
 
    Right-click on the STARTUP.BAT and SHUTDOWN.BAT files.  Click on
-   "Properties" then on the "Memory" tab.  For the "Initial environment" field,
+   "Properties", then on the "Memory" tab.  For the "Initial environment" field,
    enter in something like 4096.
    
-   After you click apply, Windows will create shortcuts in the directory with
+   After you click apply, Windows will create shortcuts
    which you can use to start and stop the container.
 
 3) The 'localhost' machine isn't found.  This could happen if you're behind a
    proxy.  If that's the case, make sure the proxy configuration for your
-   browser knows that you shouldn't be going through the proxy to access the
-   "localhost" machine.
+   browser knows that you shouldn't be going through the proxy to access
+   "localhost".
    
    In Netscape, this is under Edit/Preferences -> Advanced/Proxies, and in
    Internet Explorer, Tools -> Internet Options -> Connections -> LAN Settings.

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