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
で表示される関数のドキュメントには、単なるドキュメント文字列や関数のシグネチャ以上の情報が含まれています。また、型や定義されたファイル、非推奨として宣言されているか否かといった補助情報も表示されており、さらに、テキストの強調表示された箇所で
RET をクリックまたは入力することで、さらなる情報を得られることもよくあります。
関数型が判明している場合は、関数型指定子(The Emacs Lisp Reference ManualのType Specifiersを参照)を用いて表現されます。この型がLispプログラムによって手動で宣言されたか、あるいはコンパイラによって推論された場合に指定されます。なお、関数型の推論は、ネイティブコンパイルが有効な場合にのみ機能します(The Emacs Lisp Reference Manualのnative compilationを参照)。
autoload 形式(The Emacs Lisp
Reference Manual の Autoload
を参照)で doc string が提供されていないオートロード関数についてヘルプをリクエストした場合、*Help* バッファに表示すべき doc string は存在しません。その際、help-enable-symbol-autoload が nil 以外であれば、Emacs はその関数が定義されているファイルをロードし、そこに doc string
があるかどうかを確認しようとします。
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の変数や関数を記述するヘルプバッファには、ソースファイルがインストールされていれば、通常、対応するソースコードへのハイパーリンクが設定されています(ハイパーリンクとウェブナビゲーション機能を参照)。
マニュアルでコマンドのドキュメントを探すには、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)
ヘルプバッファで説明されている内容のソース定義を参照するバッファに切り替えます。
ユーザーオプション completions-detailed が nil 以外の場合、一部のコマンドでは補完表示時に取り得る値の詳細が表示されます。例えば、C-h o TAB を指定すると、docstring
の1行目が含まれるほか、各シンボルが関数か変数か(など)も表示されます。表示される詳細内容は、使用するコマンドによって異なります。