diff options
Diffstat (limited to 'www/tomcat41/files/tomcatctl.1')
| -rw-r--r-- | www/tomcat41/files/tomcatctl.1 | 52 |
1 files changed, 32 insertions, 20 deletions
diff --git a/www/tomcat41/files/tomcatctl.1 b/www/tomcat41/files/tomcatctl.1 index 07514a3..c0d332f 100644 --- a/www/tomcat41/files/tomcatctl.1 +++ b/www/tomcat41/files/tomcatctl.1 @@ -10,9 +10,9 @@ .Sh DESCRIPTION The .Nm -shell script provides an interface to the %%APP_TITLE%% application server. +program provides an interface to the %%APP_TITLE%% application server. .Pp -The script expects exactly one argument, either +The program expects exactly one argument, either .Ar start , .Ar restart or @@ -23,41 +23,53 @@ ignored. .It Ar start Start %%APP_TITLE%%, if it is not already running. .It Ar restart -Restart %%APP_TITLE%%. If it is already running, then it will be stopped and then -started right after that. Otherwise it will just be started up. +Restart %%APP_TITLE%%. If it is already running, then it will be stopped and +then started right after that. Otherwise it will just be started up. .It Ar stop Stop %%APP_TITLE%%, if it is actually running. .El .Sh ERRORS The following error conditions are detected. They will be checked in the -specified order. In each case where an error message is printed, the name of -the script -.Em ( basename $0 ) -will be prepended. +specified order. In each case an error message is printed with the name of the +control program prepended. .Pp -If no argument is passed, or if an argument other than +If no argument is passed, then a simple help message is printed and the +program exists with error code 0. +.Pp +If at least one argument is passed, but it is different from .Ar start , .Ar restart or .Ar stop -is passed as the first argument, then a simple help message is printed and the -script is exited with error code 64. +then the help message is printed as well, and the program exits with error +code 1. .Pp -Other than that, the following errors conditions are defined: +The following errors conditions are defined: .Bl -tag -width indent -.It Em %%APP_TITLE%% home directory cannot be found -Prints an error message and exits the script with error code 2. -.It Em %%APP_TITLE%% script cannot be found -Prints an error message and exits the script with error code 3. -.It Em Java VM cannot be found -Prints an error message and exits the script with error code 4. +.It Em Illegal program argument (error code 1) +.It Em PID file not found (error code 2) +.It Em PID file too large (error code 3) +.It Em PID file contains illegal character (error code 4) +.It Em Kill of process failed (error code 5) +.It Em %%APP_TITLE%% is already running (error code 6) +.It Em %%APP_TITLE%% is not running (error code 7) +.It Em Unable to chdir to the %%APP_TITLE%% home directory (error code 8) +.It Em Unable to open the stdout log file (error code 9) +.It Em Unable to open the stderr log file (error code 10) +.It Em Unable to start %%APP_TITLE%% (error code 11) .El .Sh FILES .Bl -tag -width -indent -.It Pa %%PREFIX%%/etc/rc.d/%%STARTUP_ORDER%%.jakarta-tomcat.sh +.It Pa %%PID_FILE%% +The %%APP_TITLE%% PID file that is used to store the process ID of the +currently running process in. It is emptied as soon as the server is stopped +and filled with the process ID when it is started. It should never be writable +for anyone but +.Em www , +.It Pa %%STARTUP_SCRIPT%% A script that starts the .Nm -script. It start %%APP_TITLE%% at startup time. +program. It is used to start %%APP_TITLE%% at startup time. .El .Sh AUTHORS .An Ernst de Haan Aq znerd@FreeBSD.org |
