help

Go to: Synopsis. Flags. Return value. MEL examples.

Synopsis

help [-documentation] [-language string] [-list] [-popupDisplayTime int] [-popupMode int] [-popupPauseTime int] [-rolloverMode int] [name/pattern]

help is undoable, queryable, and editable.

Pattern follows the following syntax:

*            matches any string
?            matches any character
[agj]        matches a, g or j
[^0-9]       matches anything but a digit
x+           matches any number of subsequent x
a{3}         matches aaa
a{3,}        matches aaa, aaaa, ...
a{3,5}       matches aaa, aaaa, or aaaaa
(ab)(CD)\2\1 matches abCDCDab (\1 to \9 available)

Flags

Long name (short name)	[argument types]	Properties
-list(-l)
List all the commands whose names match the regular expression. Pass the regular expression as the first argument to the command specified.
-documentation(-doc)
Use netscape to show the documentation associated with the single command name given. A pattern cannot be used with this flag. If no command name is specified, then this flag will go to the main documentation index.
-language(-lng)	string
Show the help for this command in the specified language. Valid values are "mel" and "python". The default is Mel. Used with the doc flag.
-popupMode(-pm)	int
Turn on or off popup help mode. This flag is mutually exclusive of the list and doc flags. In query mode, this flag needs a value.
-popupPauseTime(-ppt)	int
Set the amount of time, in milliseconds, before the popup help will be displayed. The default is 800 milliseconds. This flag is mutually exclusive of the list and doc flags. In query mode, this flag needs a value.
-popupDisplayTime(-pdt)	int
Set the amount of time, in seconds, that the popup help will be displayed. The default is 4 seconds. This flag is mutually exclusive of the list and doc flags. In query mode, this flag needs a value.
-rolloverMode(-rm)	int
Turn on or off rollover help mode. This flag is mutually exclusive of the list and doc flags. In query mode, this flag needs a value.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command

Return value

MEL examples

help -list "[a-c]*";      // List all commands starting with a, b or c
help -list "[^aeiou]+";   // List all commands without vowels!
help;                     // Print a message explaining how to use help
help -doc;                // Bring up the main on-line help index
help -language "python" -doc polySphere;   // Bring up the Python version of command documentation for the polySphere command
help -doc disable;        // Bring up the on-line help for the disable command.