= Help 組込みコマンド
:encoding: UTF-8
:lang: ja
//:title: Yash マニュアル - Help 組込みコマンド

dfn:[Help 組込みコマンド]は組込みコマンドに関する説明を表示します。

[[syntax]]
== 構文

- +help [{{コマンド}}...]+

[[description]]
== 説明

Help 組込みコマンドは、オペランドで指定した組込みコマンドに関する説明を出力します。

[[operands]]
== オペランド

{{コマンド}}::
説明を表示する組込みコマンドの名前です。

[[exitstatus]]
== 終了ステータス

エラーがない限り help コマンドの終了ステータスは 0 です。

[[notes]]
== 補足

Help コマンドは{zwsp}link:builtin.html#types[任意組込みコマンド]です。
POSIX では help コマンドの動作は規定されていません。
このコマンドは link:posix.html[POSIX 準拠モード]では使えません。

Yash の多くの組込みコマンドでは、+--help+ オプションを与えることで help コマンドの出力と同様の説明を表示させることができます。

// vim: set filetype=asciidoc expandtab:
