helpコマンドはBash組み込みコマンドの一つで、Bashの組み込みコマンド(builtin command)の情報を表示できます。組み込みコマンドはmanではなく、helpコマンドで使い方を確認できます。
目次
helpコマンドの構文
helpコマンドの構文
|
1 |
help [-dms] [pattern] |
helpコマンドの使用例
組み込みコマンドのリストを表示
(オプションなし)
helpコマンドを引数無しで用いると、すべての組み込みコマンドのリストを表示することが出来ます。以下の実行結果の言語設定はja_JP.UTF-8で日本語表示がされています。
コマンド例
|
1 |
help |
実行結果
|
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 39 40 41 42 43 44 45 46 |
GNU bash, バージョン 4.3.48(1)-release (x86_64-pc-linux-gnu) これらのシェルコマンドは内部で定義されています。`help' と入力して一覧を参照してください。 `help 名前' と入力すると `名前' という関数のより詳しい説明が得られます。 'info bash' を使用するとシェル全般のより詳しい説明が得られます。 `man -k' または info を使用すると一覧にないコマンドのより詳しい説明が得られます。 名前の後にアスタリスク (*) がある場合はそのコマンドが無効になっていることを意味します。 job_spec [&] history [-c] [-d offset] [n] または history -anrw [f> (( expression )) if COMMANDS; then COMMANDS; [ elif COMMANDS; then> . filename [arguments] jobs [-lnprs] [jobspec ...] または jobs -x command [> : kill [-s sigspec | -n signum | -sigspec] pid | jo> [ arg... ] let 引数 [引数 ...] [[ expression ]] local [option] name[=value] ... alias [-p] [name[=value] ... ] logout [n] bg [job_spec ...] mapfile [-n count] [-O origin] [-s count] [-t] [-> bind [-lpsvPSVX] [-m keymap] [-f filename] [-q nam> popd [-n] [+N | -N] break [n] printf [-v var] format [arguments] builtin [shell-builtin [arg ...]] pushd [-n] [+N | -N | dir] caller [expr] pwd [-LP] case WORD in [PATTERN [| PATTERN]...) COMMANDS ;;]> read [-ers] [-a array] [-d delim] [-i text] [-n n> cd [-L|[-P [-e]] [-@]] [dir] readarray [-n count] [-O origin] [-s count] [-t] > command [-pVv] command [arg ...] readonly [-aAf] [name[=value] ...] または readonly -> compgen [-abcdefgjksuv] [-o option] [-A action] [> return [n] complete [-abcdefgjksuv] [-pr] [-DE] [-o option] [> select NAME [in WORDS ... ;] do COMMANDS; done compopt [-o|+o option] [-DE] [name ...] set [-abefhkmnptuvxBCHP] [-o option-name] [--] [a> continue [n] shift [n] coproc [NAME] command [redirections] shopt [-pqsu] [-o] [optname ...] declare [-aAfFgilnrtux] [-p] [name[=value] ...] source filename [arguments] dirs [-clpv] [+N] [-N] suspend [-f] disown [-h] [-ar] [jobspec ...] test [expr] echo [-neE] [arg ...] time [-p] pipeline enable [-a] [-dnps] [-f filename] [name ...] times eval [arg ...] trap [-lp] [[arg] signal_spec ...] exec [-cl] [-a name] [command [arguments ...]] [re> true exit [n] type [-afptP] name [name ...] export [-fn] [name[=value] ...] または export -p typeset [-aAfFgilrtux] [-p] name[=value] ... false ulimit [-SHabcdefilmnpqrstuvxT] [limit] fc [-e ename] [-lnr] [first] [last] または fc -s [pat> umask [-p] [-S] [mode] fg [job_spec] unalias [-a] name [name ...] for NAME [in WORDS ... ] ; do COMMANDS; done unset [-f] [-v] [-n] [name ...] for (( exp1; exp2; exp3 )); do COMMANDS; done until COMMANDS; do COMMANDS; done function name { COMMANDS ; } または name () { COMMAND> 変数 - 変数の名前とその意味 getopts optstring name [arg] wait [-n] [id ...] hash [-lr] [-p pathname] [-dt] [name ...] while COMMANDS; do COMMANDS; done help [-dms] [pattern ...] { COMMANDS ; } |
組み込みコマンドの使用方法を確認
(オプションなし)
helpコマンドの後に使用方法を知りたい組み込みコマンドの名前を入力すると、その組み込みコマンドについての情報を確認できます。
コマンド例
|
1 |
help true |
実行結果
|
1 2 3 4 5 |
true: true 結果として成功を返します。 終了ステータス: 常に成功です。 |
言語設定によっては、日本語の翻訳が表示される場合があります。日本語の翻訳ではなく、原文でのhelpを確認する場合はLANG=Cを用いて実行すると、英文でのコマンドの使用方法を確認することが出来ます。
コマンド例と実行結果
コマンド例と実行結果
|
1 2 3 4 5 6 |
$LANG=C help true true: true Return a successful result. Exit Status: Always succeeds. |
また、helpコマンドで指定する引数はpatternになるので、
|
1 |
help t |
のように入力すると最初に't'から始まるパターンにマッチした組み込みコマンドの使用方法を表示します。
コマンドの簡単な説明を表示
(-dオプション)
-dオプションを用いると、コマンドの簡単な説明を表示します。
以下の例はtで始まる組み込みコマンドのリストとその説明を表示できます。
コマンド例
|
1 |
help -d t |
実行結果
|
1 2 3 4 5 6 7 |
test - Evaluate conditional expression. time - Report time consumed by pipeline's execution. times - Display process times. trap - Trap signals and other events. true - Return a successful result. type - Display information about command type. typeset - Set variable values and attributes. |
コマンドの使用方法をman風に表示
(-mオプション)
-mオプションを用いると、コマンドの使用方法の表示がmanコマンドを用いたような表示に変更されます。
コマンド例
|
1 |
help -m true |
実行結果
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
NAME true - 結果として成功を返します。 SYNOPSIS true DESCRIPTION 結果として成功を返します。 終了ステータス: 常に成功です。 SEE ALSO bash(1) IMPLEMENTATION GNU bash, バージョン 4.3.48(1)-release (x86_64-pc-linux-gnu) Copyright (C) 2013 Free Software Foundation, Inc. ライセンス GPLv3+: GNU GPL バージョン 3 またはそれ以降 <http://gnu.org/licenses/gpl.html> |
組み込みコマンドの構文を確認
(-sオプション)
-sオプションを用いると、組み込みコマンドの構文を確認することが出来ます。コマンドの構文をど忘れした時などにも利用できるでしょう。
以下の例はfで始まる組み込みコマンドの構文の一覧を表示できます。
コマンド例
|
1 |
help -s f |
実行結果
|
1 2 3 4 5 6 |
false: false fc: fc [-e ename] [-lnr] [first] [last] または fc -s [pat=rep] [command] fg: fg [job_spec] for: for NAME [in WORDS ... ] ; do COMMANDS; done for ((: for (( exp1; exp2; exp3 )); do COMMANDS; done function: function name { COMMANDS ; } または name () { COMMANDS ; } |
参考