12.3 コマンドと変数名のヘルプ

C-h x command RET (describe-command)はcommandという名前のコマンドのドキュメントをウィンドウに表示します。たとえば、

C-h x auto-fill-mode RET

はauto-fill-modeのドキュメントを表示します。これはキーにバインドされていないコマンド(通常M-xで実行する)のドキュメントを閲覧する方法です。

C-h f function RET (describe-function)はLisp関数functionのドキュメントを表示します。このコマンドはLispプログラム内で使用されるLisp関数を意図しています。たとえば式(make-vector len)を記述した直後に、make-vectorを正しく使用できているか確認したいときにはC-h f make-vector RETとタイプします。加えてすべてのコマンドはLisp関数なので、任意のコマンドのドキュメントを閲覧するためにもこのコマンドを使用できます。

C-h f RETを入力すると、バッファーのポイントがある位置の、一番内側のLisp式で呼び出されている関数の名前が有効で、Lisp関数として定義されていれば、その関数の説明が表示されます(引数を入力するときデフォルトとして関数名が表示されます)。たとえばポイントが‘(make-vector (car x)’の後ろにあるとき、ポイントを含む一番内側のリストは‘(make-vector’で始まっているので、C-h f RETにより関数make-vectorの説明が表示されます。

C-h fは、関数名を正しく記述しているか確かめたいときも便利です。C-h fのミニバッファーのプロンプトで、編集中のバッファーの関数名がデフォルトとして表示されるなら、それは定義されたLisp関数であることを意味します。本当にドキュメントを見たい訳でなければ、C-gを押してコマンドC-h fをキャンセルできます。

describe-functionによって表示される関数のドキュメントに含まれているは、単にドキュメント文字列とその関数のシグネチャ(signature)だけではありません。関数のタイプ、定義されているファイル、obsolete(廃止)と宣言されているかどかのような補助的な情報も表示されます。テキストの強調部分でRETをタイプすれば、さらに詳しい情報に到達できることも珍しくありません。

autoloadフォーム(Autoload in The Emacs Lisp Reference Manualを参照)でドキュメント文字列を提供しないautoloaded関数にたいするヘルプを要求する場合には、*Help*バッファーに表示するドキュメント文字列は存在しないでしょう。このような場合、help-enable-symbol-autoloadが非nilならEmacsはドキュメント文字列が存在するかどうか確認するためにその関数が定義されているファイルのロードを試みます。

M-x shortdocコマンドを使用して、特定トピックに関連する関数の概要を取得できます。これはたとえばstringのように、興味のある領域の入力を求めて、多くの文字列処理関連の関数をリストしたバッファーをポップアップします。

C-h fでポップアップされた*Help*バッファーに表示される関数やコマンドのドキュメントに、それらの使用例を含めるようにリクエストすることもできます。それには初期化ファイル(Emacs初期化ファイルを参照)に以下を追加してください:

(add-hook 'help-fns-describe-function-functions
          #'shortdoc-help-fns-examples-function)

C-h v (describe-variable)は、C-h fと似ていますがLisp関数ではなく、Lisp関数の説明を表示します。ポイントの周囲または前にあるLispシンボルが、定義されたLisp変数名のときはそれがデフォルトとなります。変数を参照してください。

通常Emacsの変数または関数を説明するヘルプバッファーには、ソースファイルがインストールされていれば、対応するソースコードへのハイパーリンクが含まれています(ハイパーリンクとWebナビゲーション機能を参照してください)。

マニュアルからコマンドのドキュメントを探すには、C-h F (Info-goto-emacs-command-node)を使います。これはEmacsのマニュアルだけでなく、さまざまなマニュアルを認識するので、正しいものを見つけられるでしょう。

C-h o (describe-symbol)は、C-h fやC-h vと似ていますが、これは任意のシンボル(関数、変数、フェイス)を説明します。シンボルが複数の定義をもつ場合(たとえばシンボルが関数と変数の両方の定義をもつような場合)、このコマンドはそれらすべてのドキュメントを順に表示します。

C-h 4 s (help-find-source)はヘルプバッファーで説明されているもののソース定義をvisitして、そのバッファーに切り替えます。

ユーザーオプションcompletions-detailedが非nilなら、いくつかのコマンドは補完の表示時に可能な値に関する詳細を提供します。たとえばC-h o TABならドキュメント文字列の最初を含めて、更にそれぞれのシンボルが関数なのか変数(あるいはその他)なのかを示します。どの詳細が含まれるかはコマンドの用途に依存します。