whatis コマンド

目的

コマンドが実行する機能を説明します。

構文

whatis [ -M PathName ] コマンド ...

説明

whatis コマンドは、Command パラメーターで指定したコマンド、システム・コール、ライブラリー関数、またはスペシャル・ファイル名を、catman -w コマンドを使用して作成したデータベースから検索します。 whatis コマンドはマニュアル項目からヘッダー行を表示します。 その際、man コマンドを発行して追加情報を得ることもできます。

whatis コマンドは、man -f コマンドを使用した場合と同じ働きをします。

注意 /usr/share/man/whatisデータベースがcatman-wコマンドを使ってHTMLライブラリからビルドされる場合、セクション3はセクション2または3と等価である。 セクションの詳しい説明については、man コマンドを参照してください。

フラグ

項目 説明
-M PathName 代替検索パスを指定します。 検索パスは、PathName パラメーターで指定します。 このパスは、ディレクトリーをコロンで区切ったリストで、標準マニュアル・サブディレクトリーは whatis コマンドを使ってディレクトリー内で探されます。

ls コマンドの実行内容を調べるには、下記のように入力します。

whatis ls 

以下の出力が作成されます。

ls(1)  -Displays the contents of a directory.

ファイル

項目 説明
/usr/share/man/whatis whatis データベースが入っています。