Return-Path: Delivered-To: apmail-geronimo-scm-archive@www.apache.org Received: (qmail 84155 invoked from network); 10 Feb 2006 00:47:33 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 10 Feb 2006 00:47:33 -0000 Received: (qmail 3526 invoked by uid 500); 10 Feb 2006 00:47:33 -0000 Delivered-To: apmail-geronimo-scm-archive@geronimo.apache.org Received: (qmail 3380 invoked by uid 500); 10 Feb 2006 00:47:32 -0000 Mailing-List: contact scm-help@geronimo.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: dev@geronimo.apache.org List-Id: Delivered-To: mailing list scm@geronimo.apache.org Received: (qmail 3369 invoked by uid 99); 10 Feb 2006 00:47:32 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 09 Feb 2006 16:47:32 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Thu, 09 Feb 2006 16:47:30 -0800 Received: (qmail 84106 invoked by uid 65534); 10 Feb 2006 00:47:10 -0000 Message-ID: <20060210004710.84095.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r376514 - in /geronimo/branches/1.0/modules/scripts/src/resources/bin: geronimo.bat geronimo.sh setjavaenv.bat setjavaenv.sh shutdown.bat shutdown.sh startup.bat startup.sh Date: Fri, 10 Feb 2006 00:47:07 -0000 To: scm@geronimo.apache.org From: jsisson@apache.org X-Mailer: svnmailer-1.0.6 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: jsisson Date: Thu Feb 9 16:47:07 2006 New Revision: 376514 URL: http://svn.apache.org/viewcvs?rev=376514&view=rev Log: GERONIMO-1608 - Improve script documentation (merged from trunk) Modified: geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.bat geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.sh geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.bat geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.sh geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.bat geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.sh geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.bat geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.sh Modified: geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.bat URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.bat?rev=376514&r1=376513&r2=376514&view=diff ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.bat (original) +++ geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.bat Thu Feb 9 16:47:07 2006 @@ -19,13 +19,25 @@ @REM --------------------------------------------------------------------------- @REM Start/Stop Batch file for Geronimo -@REM -@REM For usage information, just run geronimo.bat without any arguments. @REM -@REM This script is based upon Tomcat's catalina.sh file to enable +@REM This batch file is based upon Tomcat's catalina.bat file to enable @REM those familiar with Tomcat to quickly get started with Geronimo. @REM -@REM Environment Variable Prequisites +@REM This batch file can be used directly instead of startup.bat and +@REM shutdown.bat as they call this batch file anyway. +@REM +@REM You should not have to edit this file. If you wish to have environment +@REM variables set each time you run this batch file refer to the information +@REM on the setenv.bat file below. +@REM +@REM Invocation Syntax: +@REM +@REM geronimo command [geronimo_args] +@REM +@REM For detailed usage information, just run geronimo.bat without any +@REM arguments. +@REM +@REM Environment Variable Prequisites: @REM @REM GERONIMO_HOME May point at your Geronimo top-level directory. @REM If not specified, this batch file will attempt to @@ -81,7 +93,9 @@ @REM %GERONIMO_HOME%\bin\setenv.bat @REM (Optional) This batch file is called if it is present. @REM Its contents may set one or more of the above environment -@REM variables. +@REM variables. It is preferable (to simplify migration to +@REM future Geronimo releases) to set environment variables +@REM in this file rather than modifying Geronimo's script files. @REM @REM %GERONIMO_HOME%\bin\setjavaenv.bat @REM This batch file is called to set environment variables Modified: geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.sh URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.sh?rev=376514&r1=376513&r2=376514&view=diff ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.sh (original) +++ geronimo/branches/1.0/modules/scripts/src/resources/bin/geronimo.sh Thu Feb 9 16:47:07 2006 @@ -24,11 +24,25 @@ # This script is based upon Tomcat's catalina.sh file to enable # those familiar with Tomcat to quickly get started with Geronimo. # -# For usage information, just run geronimo.sh without any arguments. +# This script file can be used directly instead of startup.sh and +# shutdown.sh as they call this script file anyway. # -# Environment Variable Prequisites +# You should not have to edit this file. If you wish to have environment +# variables set each time you run this script refer to the information +# on the setenv.sh script that is called by this script below. # -# GERONIMO_HOME May point at your Geronimo top-level directory. +# Invocation Syntax: +# +# geronimo.sh command [geronimo_args] +# +# For detailed command usage information, just run geronimo.sh without any +# arguments. +# +# Environment Variable Prequisites: +# +# GERONIMO_HOME (Optional) May point at your Geronimo top-level directory. +# If not specified, it will default to the parent directory +# of the location of this script. # # GERONIMO_BASE (Optional) Base directory for resolving dynamic portions # of a Geronimo installation. If not present, resolves to @@ -84,7 +98,9 @@ # $GERONIMO_HOME/bin/setenv.sh # (Optional) This script file is called if it is present. # Its contents may set one or more of the above environment -# variables. +# variables. It is preferable (to simplify migration to +# future Geronimo releases) to set environment variables +# in this file rather than modifying Geronimo's script files. # # $GERONIMO_HOME/bin/setjavaenv.sh # This batch file is called to set environment variables Modified: geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.bat URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.bat?rev=376514&r1=376513&r2=376514&view=diff ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.bat (original) +++ geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.bat Thu Feb 9 16:47:07 2006 @@ -14,15 +14,25 @@ @REM limitations under the License. @REM @REM -------------------------------------------------------------------- +@REM $Rev$ $Date$ +@REM -------------------------------------------------------------------- + +@REM -------------------------------------------------------------------- @REM Set environment variables relating to the execution of java commands @REM -@REM This batch file is called by the geronimo.bat file. +@REM This batch file is called by the geronimo.bat file (which is +@REM invoked by the startup.bat, shutdown.bat files). This file is +@REM also invoked by the deploy.bat file. +@REM +@REM It is preferable (to simplify migration to future Geronimo releases) +@REM to set any environment variables you need in the setenv.bat file +@REM rather than modifying Geronimo's script files. See the documentation +@REM in the geronimo.bat file for further information. @REM -@REM (based upon Apache Tomcat 5.5.12's setclasspath.bat although modified +@REM (Based upon Apache Tomcat 5.5.12's setclasspath.bat although modified @REM to be more consistent with the shell script version's support of @REM JDK_HOME and JRE_HOME) @REM -@REM $Rev$ $Date$ @REM -------------------------------------------------------------------- @REM Begin all @REM lines with '@' in case GERONIMO_BATCH_ECHO is 'on' Modified: geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.sh URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.sh?rev=376514&r1=376513&r2=376514&view=diff ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.sh (original) +++ geronimo/branches/1.0/modules/scripts/src/resources/bin/setjavaenv.sh Thu Feb 9 16:47:07 2006 @@ -15,13 +15,23 @@ # limitations under the License. # -------------------------------------------------------------------- -# Set environment variables relating to the execution of java commands +# $Rev$ $Date$ +# -------------------------------------------------------------------- + +# -------------------------------------------------------------------- +# Set environment variables relating to the execution of java commands. # -# This script file is called by the geronimo.sh file. +# This script file is called by the geronimo.sh file (which is invoked +# by the startup.sh, shutdown.sh files). This file is also invoked +# by the deploy.sh file. # -# (based upon Apache Tomcat 5.5.12's setclasspath.sh) +# It is preferable (to simplify migration to future Geronimo releases) +# to set any environment variables you need in the setenv.sh file +# rather than modifying Geronimo's script files. See the documentation +# in the geronimo.sh file for further information. +# +# (Based upon Apache Tomcat 5.5.12's setclasspath.sh) # -# $Rev$ $Date$ # -------------------------------------------------------------------- # Make sure prerequisite environment variables are set Modified: geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.bat URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.bat?rev=376514&r1=376513&r2=376514&view=diff ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.bat (original) +++ geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.bat Thu Feb 9 16:47:07 2006 @@ -24,18 +24,25 @@ rem This batch file calls the geronimo.bat script passing "stop" as the rem first argument followed by the arguments supplied by the caller. rem -rem Refer to the documentation in the geronimo.bat file for information -rem on environment variables etc. -rem rem This batch file is based upon Tomcat's shutdown.bat file to enable rem those familiar with Tomcat to easily stop Geronimo. rem rem Alternatively you can use the more comprehensive geronimo.bat file rem directly. rem -rem Usage: shutdown [geronimo_args ...] +rem Invocation Syntax: +rem +rem shutdown [stop command args ...] +rem +rem Invoke the shutdown.bat file without any arguments for information +rem on arguments for the geronimo.bat stop command that is invoked by +rem this batch file. +rem +rem Environment Variable Prequisites: +rem +rem Refer to the documentation in the geronimo.bat file for information +rem on environment variables etc. rem -rem $Rev$ $Date$ rem -------------------------------------------------------------------- if "%OS%" == "Windows_NT" setlocal Modified: geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.sh URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.sh?rev=376514&r1=376513&r2=376514&view=diff ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.sh (original) +++ geronimo/branches/1.0/modules/scripts/src/resources/bin/shutdown.sh Thu Feb 9 16:47:07 2006 @@ -15,23 +15,34 @@ # limitations under the License. # -------------------------------------------------------------------- +# $Rev$ $Date$ +# -------------------------------------------------------------------- + +# -------------------------------------------------------------------- # Shutdown script file for Geronimo. # # This script calls the geronimo.sh script passing "stop" as the # first argument followed by the arguments supplied by the caller. # -# Refer to the documentation in the geronimo.sh file for information -# on environment variables etc. -# # This script is based upon Tomcat's shutdown.sh file to enable # those familiar with Tomcat to easily stop Geronimo. # # Alternatively you can use the more comprehensive geronimo.sh file # directly. # -# Usage: shutdown.sh [geronimo_args ...] +# Invocation Syntax: +# +# shutdown.sh [geronimo.sh stop command args] +# +# Invoke the shutdown.sh file without any arguments for information +# on arguments for the geronimo.sh stop command that is invoked +# by this script. +# +# Environment Variable Prequisites: +# +# Refer to the documentation in the geronimo.sh file for information +# on environment variables etc. # -# $Rev$ $Date$ # -------------------------------------------------------------------- # resolve links - $0 may be a softlink Modified: geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.bat URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.bat?rev=376514&r1=376513&r2=376514&view=diff ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.bat (original) +++ geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.bat Thu Feb 9 16:47:07 2006 @@ -14,23 +14,30 @@ @REM limitations under the License. @REM @REM -------------------------------------------------------------------- +@REM $Rev$ $Date$ +@REM -------------------------------------------------------------------- + +@REM -------------------------------------------------------------------- @REM Startup batch file for Geronimo that starts Geronimo in a new window. @REM @REM This batch file calls the geronimo.bat script passing "start" as the @REM first argument followed by the arguments supplied by the caller. @REM -@REM Refer to the documentation in the geronimo.bat file for information -@REM on environment variables etc. -@REM @REM This batch file is based upon Tomcat's startup.bat file to enable @REM those familiar with Tomcat to quickly get started with Geronimo. @REM @REM Alternatively you can use the more comprehensive geronimo.bat file @REM directly. @REM -@REM Usage: startup [geronimo.bat_args] [geronimo_args ...] +@REM Invocation Syntax: +@REM +@REM startup [geronimo_args ...] +@REM +@REM Environment Variable Prequisites: +@REM +@REM Refer to the documentation in the geronimo.bat file for information +@REM on environment variables etc. @REM -@REM $Rev$ $Date$ @REM -------------------------------------------------------------------- @if "%GERONIMO_BATCH_ECHO%" == "on" echo on Modified: geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.sh URL: http://svn.apache.org/viewcvs/geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.sh?rev=376514&r1=376513&r2=376514&view=diff ============================================================================== --- geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.sh (original) +++ geronimo/branches/1.0/modules/scripts/src/resources/bin/startup.sh Thu Feb 9 16:47:07 2006 @@ -15,23 +15,30 @@ # limitations under the License. # -------------------------------------------------------------------- +# $Rev$ $Date$ +# -------------------------------------------------------------------- + +# -------------------------------------------------------------------- # Startup script file for Geronimo that starts Geronimo in the background. # # This script calls the geronimo.sh script passing "start" as the # first argument followed by the arguments supplied by the caller. # -# Refer to the documentation in the geronimo.sh file for information -# on environment variables etc. -# # This script is based upon Tomcat's startup.sh file to enable # those familiar with Tomcat to quickly get started with Geronimo. # # Alternatively you can use the more comprehensive geronimo.sh file # directly. # -# Usage: startup.sh [geronimo.sh_args] [geronimo_args ...] +# Invocation Syntax: +# +# startup.sh [geronimo_args ...] +# +# Environment Variable Prequisites: +# +# Refer to the documentation in the geronimo.sh file for information +# on environment variables etc. # -# $Rev$ $Date$ # -------------------------------------------------------------------- os400=false