Bug 62140

Summary:	catalina.sh should document the verbs it accepts as command-line arguments
Product:	Tomcat 9	Reporter:	Christopher Schultz <chris>
Component:	Catalina	Assignee:	Tomcat Developers Mailing List <dev>
Status:	RESOLVED FIXED
Severity:	enhancement	Keywords:	Beginner
Priority:	P2
Version:	unspecified
Target Milestone:	-----
Hardware:	PC
OS:	Mac OS X 10.1

Description Christopher Schultz 2018-02-27 14:20:53 UTC

The script catalina.sh (and .bat) has a section of comments at the top that describes all of the environment variables that can be used to control it, but it does not list the various verbs it will accept (e.g. start, run, stop, jpda, version, etc.).

Running `catalina.sh` with an unrecognized verb will produce a brief "help" description of each of the commands. Having either the same brief (or, better yet, long-form) description of the commands in the comments of the file would be helpful.

Of, if there is fear that the descriptions will diverge, perhaps a notation could be made at the top of the file to "see the usage description at the bottom of this file" or even suggest running catalina.sh with a verb like "help" to get the help text.

Comment 1 mhkarunarathne 2018-04-23 04:35:37 UTC

I would like work on this bug. Could you please give me more information about this issue.

Comment 2 Christopher Schultz 2018-04-23 16:49:56 UTC

Thank you for your interest.

Please post a message to the Tomcat users' mailing list (or dev mailing list) to get more help. We prefer not to use Bugzilla as a support forum for e.g. how to check-out Tomcat source, build it, and submit patches or pull requests.

Comment 3 Dhruv 2019-02-01 11:19:13 UTC

I would like to work on this issue. Can I take this up or is someone else working on it.

Comment 4 Dhruv 2019-02-01 11:19:53 UTC

I would like to work on this issue. Can I take this up or is someone else working on it.

Comment 5 Mark Thomas 2019-02-01 11:24:51 UTC

It is yours. Go for it.

Comment 6 Steve Sanders 2019-10-23 21:39:12 UTC

(In reply to Mark Thomas from comment #5)
> It is yours. Go for it.

I wanted to take care of this as an easy into to contributing, but looks like this was already fixed with this commit: https://github.com/apache/tomcat/commit/328264a92cdec4302dbc68ef7377eebc3ecf0c4e

Should this bug be marked as closed?

Comment 7 Mark Thomas 2019-10-24 06:58:35 UTC

It should. Sorry about that. I can't remember why I fixed this rather than leaving it open.

Of the currently open bugs, 63865 looks like it should be a fairly simple one. The only caveat is it needs to be fixed before the next release which is due at the start of November so you only have ~1 week. If that doesn't work for you, ask on the dev@ list and we'll try and point you towards something else.