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

Synopsis

help [-documentation] [-language string] [-list] [-popupDisplayTime uint] [-popupMode boolean] [-popupPauseTime uint] [-popupSimpleMode boolean] [-rolloverMode boolean] [-syntaxOnly] [string]

help is undoable, queryable, and NOT editable.

With no arguments, help tells how to use help. If a command name is specified, help will return the quick help for that command. Other flags can be used to open the online documentation, or to list available commands based on a pattern.

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)

Return value

None

In query mode, return type is based on queried flag.

Flags

documentation, language, list, popupDisplayTime, popupMode, popupPauseTime, popupSimpleMode, rolloverMode, syntaxOnly
Long name (short name) Argument types Properties
-list(-l) create
List all the commands whose names match the regular expression. Pass the regular expression as the first argument to the command specified.
-documentation(-doc) create
Use a browser 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 create
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.
-syntaxOnly(-so) create
When no other flag is specified, return only the syntax part of the quick help.
-popupMode(-pm) boolean createquery
Turn on or off popup help mode. This flag is mutually exclusive of the list and doc flags.
-popupSimpleMode(-psm) boolean createquery
Turn on or off simple popup help mode. If set, ToolClips will display only name and keyboard shortcut.
-popupPauseTime(-ppt) uint createquery
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.
-popupDisplayTime(-pdt) uint createquery
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.
-rolloverMode(-rm) boolean createquery
Turn on or off rollover help mode. This flag is mutually exclusive with the list and doc flags.
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.

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.