help

ジャンプ先: 概要. 戻り値. フラグ. MEL 例.

概要

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

help は、取り消し可能、照会可能、および編集不可能です。

パターンは次の構文に従います。

*            任意の文字列に一致
?            任意の文字に一致
[agj]        a、g または j に一致
[^0-9]       数字以外に一致
x+           すぐ次の任意の数の x に一致
a{3}         aaa に一致
a{3,}        aaa、aaaa、...に一致
a{3,5}       aaa、aaaa、または aaaaa に一致
(ab)(CD)\2\1 abCDCDab に一致(\1～\9 が使用可能)

戻り値

なし

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
-list(-l)
名前が正規表現に一致するコマンドをすべてリスト表示します。正規表現を最初の引数として指定したコマンドに渡します。
-documentation(-doc)
ブラウザを使用し、指定した 1 つのコマンド名に関連したマニュアルを表示します。パターンをこのフラグと一緒に使うことはできません。コマンド名が指定されていない場合、このフラグはマニュアルのメイン インデックスに進みます。
-language(-lng)	string
このコマンドのヘルプを指定した言語で表示します。有効な値は、「mel」と「python」です。既定は Mel です。doc フラグと一緒に使用します。
-syntaxOnly(-so)
その他のフラグを指定しないと、クイック ヘルプの構文部分のみを返します。
-popupMode(-pm)	boolean
ポップアップ ヘルプ モードをオンまたはオフにします。このフラグは、list フラグと doc フラグとは相互に排他的です。
-popupSimpleMode(-psm)	boolean
簡易ポップアップ ヘルプ モードをオンまたはオフにします。設定すると、ツールクリップに名前とキーボード ショートカットだけが表示されます。
-popupPauseTime(-ppt)	uint
ポップアップ ヘルプが表示されるまでの時間をミリ秒単位で設定します。既定は 800 ミリ秒です。このフラグは、list フラグと doc フラグとは相互に排他的です。
-popupDisplayTime(-pdt)	uint
ポップアップ ヘルプが表示される時間を秒単位で設定します。既定は 4 秒です。このフラグは、list フラグと doc フラグとは相互に排他的です。
-rolloverMode(-rm)	boolean
ロールオーバー ヘルプ モードをオンまたはオフにします。このフラグは、list フラグと doc フラグとは相互に排他的です。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	コマンド内でフラグを複数回使用できます。

MEL 例

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.