Description
This command either launches Shogun's online help or prints the syntax for a command to the command log.
Functional area
System
Command syntax
Syntax
help ["topic"][-syntax] |
Arguments
| Name | Type | Required | Comments |
|---|---|---|---|
topic | string | no | The command name or topic for which to show information. If you specify the -syntax flag, then this should be the name of a command. If you do not specify the -syntax flag, Shogun launches its online help pages and attempts to locate this topic. |
Flags
| Name | Flag arguments | Argument type | Exclusive to | Comments |
|---|---|---|---|---|
syntax | 0 | — | — | Prints the syntax for the topic to the command log. If you specify this flag you must specify a valid command name. Without this flag, Shogun launches its online help pages. |
Return value
void
Examples
// Display the syntax for the "create" command in the Log line in
// the status bar and in the Log Viewer
help create -syntax;
// Open Shogun's Help documentation and look for an index item of
// the string "clean up data"
help "clean up data";
