skip to main content
TCMAN Reference : General actions : Display help (help)
 

Display help (help)

Purpose

Display summary or detailed help for all TCMAN actions, property names, and server features.

Syntax

tcman.sh help [action|property|feature]

Parameters

action
Show the syntax and options of the specified action. If no action is specified, show a list of all actions and the general options.
property
Show the settings for specified property.
feature
Show if the specified feature is enabled or disabled.

Example

Display the usage help for the create action:
$: tcman.sh help create
usage: tcman create [options] -p <http-port> [instance-opts] <new-base-path>
instance-opts:
[-s <shutdown-port>]
[-P <https-port>]
[-j <ajp13-port>]
[-W <web-apps-dir>]
[-N <inst-alias-name>]
[-U <file-owner> -G <file-group>]

general options:
-u uid:pwd pass uid and pwd for HTTP BASIC authentication
-v print verbose output
-M url override the CATALINA_BASE manager's URL with
<{http|https}://<host>:<port>/<mgr-app>
-B override CATALINA_BASE environment setting
-n debug run action but do not execute changes