helpはコマンドのマニュアルを表示するコマンドだ。
このページではコマンドのマニュアルを表示する方法を解説する。
目次
helpコマンドの基本
コマンドの基本動作
使い方は、次のとおりだ。
$ help コマンド名
forコマンドのマニュアルを表示する場合は、次のコマンドだ。
$ help for
forコマンドのマニュアル情報を表示した。
コマンド名を指定しない場合
コマンド名を指定しない場合は、helpコマンドで表示できるコマンドの一覧を、簡単な説明付きで表示する。
$ help
コマンド名を指定しなかったので、helpコマンドで表示できるコマンドの一覧を、簡単な説明付きで表示した。
コマンド名のヘルプトピックが見つからなかった場合
タイプミスなどでコマンド名が間違っているとヘルプトピックは見つからず、エラーとなる。
$ help fol
folコマンドのヘルプトピックがないため、エラーとなった。
複数コマンドを指定した場合
複数のコマンドを同時に指定すると、複数のマニュアルを一度に表示する。
exitコマンドのマニュアルに続き、forコマンドを表示する場合は、次のコマンドだ。
$ help exit for
exitコマンドのマニュアルに続き、forコマンドを表示した。
helpコマンドのオプションたち
オプションの一覧
後から詳細をご紹介するが、まずは一覧で見てみよう。
オプション -d
トピックの簡単な説明を表示する。
オプション -m
マニュアル形式での使用法を表示する。
オプション -s
短い使用法で表示する。
-dオプション：トピックの簡単な説明を表示する
コマンドのマニュアルを簡単な説明で表示する書式は次のとおりだ。
$ help -d コマンド名
forコマンドのマニュアルを簡単な説明で表示する場合は、次のコマンドだ。
$ help -d for
forコマンドのマニュアルを簡単な説明で表示した。
-mオプション：マニュアル形式での使用法を表示する
コマンドのマニュアルを、マニュアル形式で表示する書式は次のとおりだ。
$ help -m コマンド名
forコマンドのマニュアルを、マニュアル形式で表示する場合は、次のコマンドだ。
$ help -m for
forコマンドのマニュアルを、マニュアル形式で表示した。
-sオプション：短い使用法で表示する
コマンドのマニュアルを、短い使用法で表示する書式は次のとおりだ。
$ help -s コマンド名
forコマンドのマニュアルを、短い使用法で表示する場合は、次のコマンドだ。
$ help -s for
forコマンドのマニュアルを、短い使用法で表示した。
forコマンドの場合は表示されないが、オプションが指定可能なコマンドの場合は、指定可能なオプションの種類が表示される。
例えば、echoコマンドのマニュアルを、短い使用法の概要で表示する場合は、次のコマンドだ。
$ help -s echo
echoコマンドはオプションが指定できるので、指定できるオプションの種類も表示された。
help関連コマンド
最後にhelpコマンドに関連して、基本的なマニュアルを表示するコマンドも紹介しておく。
manコマンド
マニュアルの表示
whatisコマンド
コマンドやファイルが何か調べて表示する
まとめ
helpコマンドはタイプミスによってコマンド名が間違っている場合の他、ヘルプトピックがないコマンドについてはエラーとなる。意外とスタンダードなlsコマンドなども表示されないケースがある。
その場合、manコマンドやwhatisコマンドを利用しよう。
それぞれのコマンドは--helpオプションでヘルプを表示できるが、helpコマンドは使用目的に応じて、オプションで３種類の表示形式を選べるのが便利だ。ぜひ活用してほしい。
