Fixed the man page for tomcatctl.

3 files changed, 54 insertions, 117 deletions

diff --git a/www/jakarta-tomcat4/Makefile b/www/jakarta-tomcat4/Makefile
index 2a8597c4167c..f6b3c8f87c76 100644
--- a/www/jakarta-tomcat4/Makefile
+++ b/www/jakarta-tomcat4/Makefile
@@ -7,7 +7,7 @@
 
 PORTNAME=	jakarta-tomcat
 PORTVERSION=	3.2.4
-PORTREVISION=	1
+PORTREVISION=	2
 CATEGORIES=	www java
 MASTER_SITES=	http://jakarta.apache.org/builds/jakarta-tomcat/release/v${PORTVERSION}/bin/ \
 		http://www.metaverse.nl/~ernst/ \
@@ -114,7 +114,10 @@ do-install:
 	@# Install the man page
 .if !defined(NOPORTDOCS)
 	${CAT} ${FILESDIR}/${CONTROL_SCRIPT_NAME}.1 \
+	| ${SED} "/%%APP_TITLE%%/s//${APP_TITLE}/" \
 	| ${SED} "/%%PREFIX%%/s//${PREFIX:S/\//\\\//g}/" \
+	| ${SED} "/%%CONTROL_SCRIPT_NAME%%/s//${CONTROL_SCRIPT_NAME}/" \
+	| ${SED} "/%%STARTUP_ORDER%%/s//${STARTUP_ORDER}.sh/" \
 	> ${WRKDIR}/${CONTROL_SCRIPT_NAME}.1
 	${INSTALL_MAN} ${WRKDIR}/${CONTROL_SCRIPT_NAME}.1 ${MANPREFIX}/man/man1
 .endif
diff --git a/www/jakarta-tomcat4/files/daemonctl.1 b/www/jakarta-tomcat4/files/daemonctl.1
index 6fb6de835686..07514a35bcea 100644
--- a/www/jakarta-tomcat4/files/daemonctl.1
+++ b/www/jakarta-tomcat4/files/daemonctl.1
@@ -1,96 +1,63 @@
-.Dd May 26, 2001
+.Dd February 21, 2002
 .Dt TOMCATCTL 1
 .Os FreeBSD
 .Sh NAME
-.Nm tomcatctl
-.Nd Tomcat server control interface
+.Nm %%CONTROL_SCRIPT_NAME%%
+.Nd %%APP_TITLE%% server control interface
 .Sh SYNOPSIS
 .Nm
-.Op Ar start | Ar stop
+.Op Ar start | Ar restart | Ar stop
 .Sh DESCRIPTION
 The
 .Nm
-shell script provides an interface to the Tomcat application server.
-.Pp
-This script has 2 modes of operation, One is
-.Em shell script mode
-and the other is
-.Em rc script mode .
-If run as
-.Nm
-shell script mode is used, otherwise rc script mode is used. Shell script mode
-assumes that the script is used as a normal shell script, while rc script mode
-assumes the script is used to start or stop Tomcat at boot time.
+shell script provides an interface to the %%APP_TITLE%% application server.
 .Pp
 The script expects exactly one argument, either
-.Ar start
+.Ar start ,
+.Ar restart
 or
 .Ar stop .
 If more than one argument is given, then all arguments but the first are
 ignored.
 .Bl -tag -width indent
 .It Ar start
-Start Tomcat, if it is not already running. The ID of the started process will
-be saved in a PID file.
+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.
 .It Ar stop
-Stop Tomcat, if it is actually running. The process with the ID stored in
-the PID file will be killed.
+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 every case where an error message is printed it will be
-prepended by the name of the script
-.Em ( basename $0 ) .
+specified order. In each case where an error message is printed, the name of
+the script
+.Em ( basename $0 )
+will be prepended.
 .Pp
 If no argument is passed, or if an argument other than
-.Ar start
+.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.
 .Pp
-In 
-.Em rc script mode
-a newline will be printed before any error message.
-.Pp
-When using the argument
-.Ar start
-the following errors conditions can be triggered:
+Other than that, the following errors conditions are defined:
 .Bl -tag -width indent
-.It Em The Tomcat PID file already exists.
-Tomcat is probably already running. Prints an error message and exits the
-script with error code 1.
-.It Em Tomcat home directory cannot be found
+.It Em %%APP_TITLE%% home directory cannot be found
 Prints an error message and exits the script with error code 2.
-.It Em Tomcat script cannot be found
+.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.
 .El
-.Pp
-When using the argument
-.Ar stop
-the following error condition can be triggered:
-.Bl -tag -width indent
-.It Em The Tomcat PID file cannot be found
-Tomcat is probably not running. Prints an error message and exits the script
-with error code 16.
-.El
 .Sh FILES
 .Bl -tag -width -indent
-.It Pa /var/run/jakarta-tomcat.pid
-The Tomcat PID file that is used to store the process ID of the currently
-running Tomcat process in. It is deleted as soon as Tomcat is stopped and
-recreated when Tomcat is started. It should never be writable for anyone but
-.Em root ,
-.It Pa %%PREFIX%%/etc/rc.d/jakarta-tomcat.sh
-A symlink to the
-.Nm
-script. This causes Tomcat to be started at boot time. When called from this
-location the
+.It Pa %%PREFIX%%/etc/rc.d/%%STARTUP_ORDER%%.jakarta-tomcat.sh
+A script that starts the
 .Nm
-script will use
-.Em rc script mode .
+script. It start %%APP_TITLE%% at startup time.
 .El
 .Sh AUTHORS
-.An Ernst de Haan Aq ernst@jollem.com
+.An Ernst de Haan Aq znerd@FreeBSD.org
diff --git a/www/jakarta-tomcat4/files/tomcatctl.1 b/www/jakarta-tomcat4/files/tomcatctl.1
index 6fb6de835686..07514a35bcea 100644
--- a/www/jakarta-tomcat4/files/tomcatctl.1
+++ b/www/jakarta-tomcat4/files/tomcatctl.1
@@ -1,96 +1,63 @@
-.Dd May 26, 2001
+.Dd February 21, 2002
 .Dt TOMCATCTL 1
 .Os FreeBSD
 .Sh NAME
-.Nm tomcatctl
-.Nd Tomcat server control interface
+.Nm %%CONTROL_SCRIPT_NAME%%
+.Nd %%APP_TITLE%% server control interface
 .Sh SYNOPSIS
 .Nm
-.Op Ar start | Ar stop
+.Op Ar start | Ar restart | Ar stop
 .Sh DESCRIPTION
 The
 .Nm
-shell script provides an interface to the Tomcat application server.
-.Pp
-This script has 2 modes of operation, One is
-.Em shell script mode
-and the other is
-.Em rc script mode .
-If run as
-.Nm
-shell script mode is used, otherwise rc script mode is used. Shell script mode
-assumes that the script is used as a normal shell script, while rc script mode
-assumes the script is used to start or stop Tomcat at boot time.
+shell script provides an interface to the %%APP_TITLE%% application server.
 .Pp
 The script expects exactly one argument, either
-.Ar start
+.Ar start ,
+.Ar restart
 or
 .Ar stop .
 If more than one argument is given, then all arguments but the first are
 ignored.
 .Bl -tag -width indent
 .It Ar start
-Start Tomcat, if it is not already running. The ID of the started process will
-be saved in a PID file.
+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.
 .It Ar stop
-Stop Tomcat, if it is actually running. The process with the ID stored in
-the PID file will be killed.
+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 every case where an error message is printed it will be
-prepended by the name of the script
-.Em ( basename $0 ) .
+specified order. In each case where an error message is printed, the name of
+the script
+.Em ( basename $0 )
+will be prepended.
 .Pp
 If no argument is passed, or if an argument other than
-.Ar start
+.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.
 .Pp
-In 
-.Em rc script mode
-a newline will be printed before any error message.
-.Pp
-When using the argument
-.Ar start
-the following errors conditions can be triggered:
+Other than that, the following errors conditions are defined:
 .Bl -tag -width indent
-.It Em The Tomcat PID file already exists.
-Tomcat is probably already running. Prints an error message and exits the
-script with error code 1.
-.It Em Tomcat home directory cannot be found
+.It Em %%APP_TITLE%% home directory cannot be found
 Prints an error message and exits the script with error code 2.
-.It Em Tomcat script cannot be found
+.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.
 .El
-.Pp
-When using the argument
-.Ar stop
-the following error condition can be triggered:
-.Bl -tag -width indent
-.It Em The Tomcat PID file cannot be found
-Tomcat is probably not running. Prints an error message and exits the script
-with error code 16.
-.El
 .Sh FILES
 .Bl -tag -width -indent
-.It Pa /var/run/jakarta-tomcat.pid
-The Tomcat PID file that is used to store the process ID of the currently
-running Tomcat process in. It is deleted as soon as Tomcat is stopped and
-recreated when Tomcat is started. It should never be writable for anyone but
-.Em root ,
-.It Pa %%PREFIX%%/etc/rc.d/jakarta-tomcat.sh
-A symlink to the
-.Nm
-script. This causes Tomcat to be started at boot time. When called from this
-location the
+.It Pa %%PREFIX%%/etc/rc.d/%%STARTUP_ORDER%%.jakarta-tomcat.sh
+A script that starts the
 .Nm
-script will use
-.Em rc script mode .
+script. It start %%APP_TITLE%% at startup time.
 .El
 .Sh AUTHORS
-.An Ernst de Haan Aq ernst@jollem.com
+.An Ernst de Haan Aq znerd@FreeBSD.org