File: _help.txt

package info (click to toggle)
yash 2.60-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,152 kB
  • sloc: ansic: 34,578; makefile: 851; sh: 808; sed: 16
file content (38 lines) | stat: -rw-r--r-- 1,147 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
= 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: