Bug 62140 - catalina.sh should document the verbs it accepts as command-line arguments
Summary: catalina.sh should document the verbs it accepts as command-line arguments
Status: NEW
Alias: None
Product: Tomcat 9
Classification: Unclassified
Component: Catalina (show other bugs)
Version: unspecified
Hardware: PC Mac OS X 10.1
: P2 enhancement (vote)
Target Milestone: -----
Assignee: Tomcat Developers Mailing List
URL:
Keywords: Beginner
Depends on:
Blocks:
 
Reported: 2018-02-27 14:20 UTC by Christopher Schultz
Modified: 2019-02-01 11:24 UTC (History)
0 users



Attachments

Note You need to log in before you can comment on or make changes to this bug.
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.